Skip to content

Commit 9eb3ece

Browse files
authored
Small fix for building docs in CI/CD and update sphinx (#1674)
**Summarize your change.** Small fix for new path of the api docs Update sphinx to 8.1.3 and sphinx-rtd-theme to 3.0.2
1 parent 2a422b0 commit 9eb3ece

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

api_docs/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@
9595
#
9696
html_theme_options = {
9797
'logo_only': True,
98-
'display_version': True,
9998
'prev_next_buttons_location': 'bottom',
10099
'style_external_links': True,
101100
'style_nav_header_background': 'white',
@@ -199,7 +198,7 @@
199198
# -- Options for intersphinx extension ---------------------------------------
200199

201200
# Example configuration for intersphinx: refer to the Python standard library.
202-
intersphinx_mapping = {'https://docs.python.org/': None}
201+
# intersphinx_mapping = {'https://docs.python.org/': None}
203202

204203
# -- Options for todo extension ----------------------------------------------
205204

api_docs/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
sphinx==5.0.0
2-
sphinx-rtd-theme==1.0.0
1+
sphinx==8.1.3
2+
sphinx-rtd-theme==3.0.2

ci/build_sphinx_docs.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
set -e
44

55
# Sphinx has some additional requirements
6-
pip install --user -r requirements.txt -r docs/requirements.txt
6+
pip install --user -r requirements.txt -r api_docs/requirements.txt
77

88
# Must generate Python code from Protos in order for Sphinx to build the docs.
99
python -m grpc_tools.protoc -I=proto/ --python_out=pycue/opencue/compiled_proto --grpc_python_out=pycue/opencue/compiled_proto proto/*.proto
@@ -13,4 +13,4 @@ python -m grpc_tools.protoc -I=proto/ --python_out=pycue/opencue/compiled_proto
1313
python ci/fix_compiled_proto.py pycue/opencue/compiled_proto
1414

1515
# Build the docs and treat warnings as errors
16-
~/.local/bin/sphinx-build -W -b html -d docs/_build/doctrees docs docs/_build/html
16+
~/.local/bin/sphinx-build -W -b html -d api_docs/_build/doctrees api_docs api_docs/_build/html

0 commit comments

Comments
 (0)