Skip to content

Commit 4a3500e

Browse files
committed
Switch from ReadTheDocs to GitHub Pages
1 parent 4342995 commit 4a3500e

File tree

4 files changed

+32
-26
lines changed

4 files changed

+32
-26
lines changed

.github/workflows/publish-site.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Deploy documentation
3+
4+
on:
5+
push:
6+
branches: [main]
7+
pull_request:
8+
branches: [main]
9+
10+
jobs:
11+
pages:
12+
runs-on: ubuntu-latest
13+
environment:
14+
name: ${{ github.ref_name == 'main' && 'github-pages' || 'development' }}
15+
url: ${{ steps.deployment.outputs.page_url }}
16+
permissions:
17+
pages: write
18+
id-token: write
19+
steps:
20+
- id: deployment
21+
uses: sphinx-notes/pages@v3
22+
with:
23+
documentation_path: docs/source
24+
pyproject_extras: dev
25+
python_version: '3.13'
26+
sphinx_build_options: -W
27+
publish: ${{ github.ref_name == 'main' }}

README.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
|Build Status| |codecov| |PyPI| |Documentation Status|
1+
|Build Status| |codecov| |PyPI|
22

33
VWS Mock
44
========
@@ -45,12 +45,12 @@ It is possible run a Mock VWS instance using Docker containers.
4545

4646
This allows you to run tests against a mock VWS instance regardless of the language or tooling you are using.
4747

48-
See the `the instructions <https://vws-python-mock.readthedocs.io/en/latest/docker.html>`__ for how to do this.
48+
See the `the instructions <https://vws-python.github.io/vws-python-mock/docker.html>`__ for how to do this.
4949

5050
Full documentation
5151
------------------
5252

53-
See the `full documentation <https://vws-python-mock.readthedocs.io/en/latest>`__.
53+
See the `full documentation <https://vws-python.github.io/vws-python-mock/>`__.
5454
This includes details on how to use the mock, options, and details of the differences between the mock and the real Vuforia Web Services.
5555

5656

@@ -60,7 +60,4 @@ This includes details on how to use the mock, options, and details of the differ
6060
:target: https://codecov.io/gh/VWS-Python/vws-python-mock
6161
.. |PyPI| image:: https://badge.fury.io/py/VWS-Python-Mock.svg
6262
:target: https://badge.fury.io/py/VWS-Python-Mock
63-
.. |Documentation Status| image:: https://readthedocs.org/projects/vws-python-mock/badge/?version=latest
64-
:target: https://vws-python-mock.readthedocs.io/en/latest/?badge=latest
65-
:alt: Documentation Status
6663
.. |minimum-python-version| replace:: 3.13

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ optional-dependencies.dev = [
109109
"yamlfix==1.17.0",
110110
]
111111
optional-dependencies.release = [ "check-wheel-contents==0.6.1" ]
112-
urls.Documentation = "https://vws-python-mock.readthedocs.io"
112+
urls.Documentation = "https://vws-python.github.io/vws-python-mock/"
113113
urls.Source = "https://github.com/VWS-Python/vws-python-mock"
114114

115115
[tool.setuptools]
@@ -314,7 +314,7 @@ ignore = [
314314
".yamlfmt",
315315
"*.enc",
316316
"admin/**",
317-
"readthedocs.yaml",
317+
318318
"CHANGELOG.rst",
319319
"CODE_OF_CONDUCT.rst",
320320
"CONTRIBUTING.rst",

readthedocs.yaml

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)