Skip to content

Commit bf54294

Browse files
Merge pull request #1259 from VWS-Python/docs-github-pages-4
Switch from ReadTheDocs to GitHub pages
2 parents 574d282 + da6366c commit bf54294

File tree

4 files changed

+29
-24
lines changed

4 files changed

+29
-24
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: 2 additions & 5 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 Auth Tools
44
==============
@@ -63,15 +63,12 @@ Usage
6363
Full Documentation
6464
------------------
6565

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

6868
.. |Build Status| image:: https://github.com/VWS-Python/vws-auth-tools/actions/workflows/ci.yml/badge.svg?branch=main
6969
:target: https://github.com/VWS-Python/vws-auth-tools/actions
7070
.. |codecov| image:: https://codecov.io/gh/VWS-Python/vws-auth-tools/branch/main/graph/badge.svg
7171
:target: https://codecov.io/gh/VWS-Python/vws-auth-tools
72-
.. |Documentation Status| image:: https://readthedocs.org/projects/vws-auth-tools/badge/?version=latest
73-
:target: https://vws-auth-tools.readthedocs.io/en/latest/?badge=latest
74-
:alt: Documentation Status
7572
.. |PyPI| image:: https://badge.fury.io/py/VWS-Auth-Tools.svg
7673
:target: https://badge.fury.io/py/VWS-Auth-Tools
7774
.. |minimum-python-version| replace:: 3.12

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,6 @@ ignore = [
272272
"*.enc",
273273
".markdownlint.json",
274274
".pre-commit-config.yaml",
275-
"readthedocs.yaml",
276275
"CHANGELOG.rst",
277276
"CODE_OF_CONDUCT.rst",
278277
"CONTRIBUTING.rst",

readthedocs.yaml

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

0 commit comments

Comments
 (0)