Skip to content

Commit a27c6e7

Browse files
committed
Merge remote-tracking branch 'origin/main' into python-3.13
2 parents 22dc04a + bf54294 commit a27c6e7

File tree

5 files changed

+40
-32
lines changed

5 files changed

+40
-32
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.13

docs/source/conf.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,19 @@
44
"""
55

66
import importlib.metadata
7+
from pathlib import Path
78

89
from packaging.specifiers import SpecifierSet
10+
from sphinx_pyproject import SphinxConfig
911

10-
project = "VWS-Auth-Tools"
11-
author = "Adam Dangoor"
12+
_pyproject_file = Path(__file__).parent.parent.parent / "pyproject.toml"
13+
_pyproject_config = SphinxConfig(
14+
pyproject_file=_pyproject_file,
15+
config_overrides={"version": None},
16+
)
17+
18+
project = _pyproject_config.name
19+
author = _pyproject_config.author
1220

1321
extensions = [
1422
"sphinx_copybutton",

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ optional-dependencies.dev = [
6464
"sphinx==8.2.0",
6565
"sphinx-copybutton==0.5.2",
6666
"sphinx-lint==1.0.0",
67+
"sphinx-pyproject==0.3.0",
6768
"sphinx-substitution-extensions==2025.2.19",
6869
"sphinxcontrib-spelling==8.0.1",
6970
"sybil==9.1.0",
@@ -271,7 +272,6 @@ ignore = [
271272
"*.enc",
272273
".markdownlint.json",
273274
".pre-commit-config.yaml",
274-
"readthedocs.yaml",
275275
"CHANGELOG.rst",
276276
"CODE_OF_CONDUCT.rst",
277277
"CONTRIBUTING.rst",

readthedocs.yaml

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

0 commit comments

Comments
 (0)