Skip to content

Switch from ReadTheDocs to GitHub Pages #2536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/workflows/publish-site.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Deploy documentation

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
pages:
runs-on: ubuntu-latest
environment:
name: ${{ github.ref_name == 'main' && 'github-pages' || 'development' }}
url: ${{ steps.deployment.outputs.page_url }}
permissions:
pages: write
id-token: write
steps:
- id: deployment
uses: sphinx-notes/pages@v3
with:
documentation_path: docs/source
pyproject_extras: dev
python_version: '3.13'
sphinx_build_options: -W
publish: ${{ github.ref_name == 'main' }}
9 changes: 3 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
|Build Status| |codecov| |PyPI| |Documentation Status|
|Build Status| |codecov| |PyPI|

VWS Mock
========
Expand Down Expand Up @@ -45,12 +45,12 @@ It is possible run a Mock VWS instance using Docker containers.

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

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

Full documentation
------------------

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


Expand All @@ -60,7 +60,4 @@ This includes details on how to use the mock, options, and details of the differ
:target: https://codecov.io/gh/VWS-Python/vws-python-mock
.. |PyPI| image:: https://badge.fury.io/py/VWS-Python-Mock.svg
:target: https://badge.fury.io/py/VWS-Python-Mock
.. |Documentation Status| image:: https://readthedocs.org/projects/vws-python-mock/badge/?version=latest
:target: https://vws-python-mock.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |minimum-python-version| replace:: 3.13
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ optional-dependencies.dev = [
"yamlfix==1.17.0",
]
optional-dependencies.release = [ "check-wheel-contents==0.6.1" ]
urls.Documentation = "https://vws-python-mock.readthedocs.io"
urls.Documentation = "https://vws-python.github.io/vws-python-mock/"
urls.Source = "https://github.com/VWS-Python/vws-python-mock"

[tool.setuptools]
Expand Down Expand Up @@ -314,7 +314,7 @@ ignore = [
".yamlfmt",
"*.enc",
"admin/**",
"readthedocs.yaml",

"CHANGELOG.rst",
"CODE_OF_CONDUCT.rst",
"CONTRIBUTING.rst",
Expand Down
18 changes: 0 additions & 18 deletions readthedocs.yaml

This file was deleted.

Loading