Skip to content

Commit

Permalink
Merge pull request #1259 from VWS-Python/docs-github-pages-4
Browse files Browse the repository at this point in the history
Switch from ReadTheDocs to GitHub pages
  • Loading branch information
adamtheturtle authored Feb 22, 2025
2 parents 574d282 + da6366c commit bf54294
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 24 deletions.
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' }}
7 changes: 2 additions & 5 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 Auth Tools
==============
Expand Down Expand Up @@ -63,15 +63,12 @@ Usage
Full Documentation
------------------

See the `full documentation <https://vws-auth-tools.readthedocs.io/en/latest>`__.
See the `full documentation <https://vws-python.github.io/vws-auth-tools/>`__.

.. |Build Status| image:: https://github.com/VWS-Python/vws-auth-tools/actions/workflows/ci.yml/badge.svg?branch=main
:target: https://github.com/VWS-Python/vws-auth-tools/actions
.. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-auth-tools/branch/main/graph/badge.svg
:target: https://codecov.io/gh/VWS-Python/vws-auth-tools
.. |Documentation Status| image:: https://readthedocs.org/projects/vws-auth-tools/badge/?version=latest
:target: https://vws-auth-tools.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |PyPI| image:: https://badge.fury.io/py/VWS-Auth-Tools.svg
:target: https://badge.fury.io/py/VWS-Auth-Tools
.. |minimum-python-version| replace:: 3.12
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,6 @@ ignore = [
"*.enc",
".markdownlint.json",
".pre-commit-config.yaml",
"readthedocs.yaml",
"CHANGELOG.rst",
"CODE_OF_CONDUCT.rst",
"CONTRIBUTING.rst",
Expand Down
18 changes: 0 additions & 18 deletions readthedocs.yaml

This file was deleted.

0 comments on commit bf54294

Please sign in to comment.