Skip to content

Commit 9f04e12

Browse files
Your Nameriddell-stan
authored andcommitted
fix: Remove unmaintained sphinxcontrib-redoc
sphinxcontrib-redoc (latest release 1.6.0, unmaintained) imports the pkg_resources module which setuptools removed in version 81. The spec is already rendered natively on the rest_api page by the maintained sphinxcontrib-openapi `.. openapi::` directive. It doesn't look as nice as redoc but it will have to do.
1 parent e10c4d2 commit 9f04e12

5 files changed

Lines changed: 1 addition & 16 deletions

File tree

doc/conf.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,6 @@
1212
"sphinx.ext.napoleon",
1313
"sphinx.ext.viewcode",
1414
"sphinxcontrib.openapi",
15-
"sphinxcontrib.redoc",
16-
]
17-
18-
redoc = [
19-
{
20-
"name": "httpstan API",
21-
"page": "api",
22-
"spec": "openapi.yaml",
23-
},
2415
]
2516

2617
source_suffix = ".rst"

doc/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,6 @@ User Guide
116116
.. _CmdStan: http://mc-stan.org/interfaces/cmdstan.html
117117
.. _PyStan: http://mc-stan.org/interfaces/pystan.html
118118
.. _Stan: http://mc-stan.org/
119-
.. _`OpenAPI documentation for httpstan`: api.html
120119

121120
.. |pypi| image:: https://img.shields.io/pypi/v/httpstan.svg
122121
:target: https://pypi.org/project/httpstan/

doc/rest_api.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@ HTTP-based REST API
44
Users interact with ``httpstan`` using an HTTP-based REST API. This page
55
describes the API.
66

7-
An alternative single-page rendering of this documentation is available:
8-
`httpstan HTTP-based REST API <api.html>`_.
9-
10-
This page and the alternative rendering are generated from an OpenAPI spec.
7+
This page is generated from an OpenAPI spec.
118
This API uses conventions described in the document `API Design Guide <https://cloud.google.com/apis/design/>`_.
129

1310
.. openapi:: openapi.yaml

docs-requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ sphinx~=7.2 # BSD
1111
sphinx-autoapi~=3.0.0
1212
sphinx-rtd-theme~=2.0.0
1313
sphinxcontrib-openapi~=0.8.4
14-
sphinxcontrib-redoc~=1.6
1514

1615
# required for building OpenAPI spec
1716
apispec[yaml]~=6.0

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ sphinx = "^7.2"
5353
sphinx-autoapi = "^3.0.0"
5454
sphinx-rtd-theme = "^2.0.0"
5555
sphinxcontrib-openapi = "^0.8.4"
56-
sphinxcontrib-redoc = "^1.6"
5756

5857
[tool.black]
5958
line-length = 119

0 commit comments

Comments
 (0)