Skip to content

Commit 672ca4c

Browse files
authored
Switch to the Nvidia Sphinx Theme for documentation (#2203)
* Adopt updated version of Sphinx, which in turn required updates to other packages. * Updated Sphinx required removing the version pins from PR #2158 * Replace usage of pytest-kafka with kafka-python-ng to adopt better support for python 3.12 * Install `exhale` with `pip` to work-around issue conda-forge/exhale-feedstock#8 * Adopt `sphinx-copybutton` removing the need for custom JS code in the repo. Closes #2141 ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/nv-morpheus/Morpheus/blob/main/docs/source/developer_guide/contributing.md). - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. Authors: - David Gardner (https://github.com/dagardner-nv) Approvers: - Will Killian (https://github.com/willkill07) URL: #2203
1 parent 54047be commit 672ca4c

22 files changed

+84
-634
lines changed

ci/conda/recipes/morpheus-libs/meta.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,14 +103,14 @@ outputs:
103103
- python-confluent-kafka =2.6.1
104104
- python-graphviz
105105
- rapids-dask-dependency {{ rapids_version }} # provides dask and distributed
106-
- requests<2.29.0
106+
- requests>=2.32.3,<3
107107
- requests-cache =1.1.*
108108
- scikit-learn =1.3.2.*
109109
- sqlalchemy <2.0 # 2.0 is incompatible with pandas=1.3
110110
- tqdm =4.*
111111
- tritonclient =2.34.*
112112
- typing_utils =0.1.*
113-
- urllib3<2.0
113+
- urllib3>=2.3,<3
114114
- watchdog =3.0.*
115115
- websockets
116116
test:

ci/conda/recipes/morpheus/meta.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,14 +109,14 @@ outputs:
109109
- python-confluent-kafka =2.6.1
110110
- python-graphviz
111111
- rapids-dask-dependency {{ rapids_version }} # provides dask and distributed
112-
- requests<2.29.0
112+
- requests>=2.32.3,<3
113113
- requests-cache =1.1.*
114114
- scikit-learn =1.3.2.*
115115
- sqlalchemy <2.0 # 2.0 is incompatible with pandas=1.3
116116
- tqdm =4.*
117117
- tritonclient =2.34.*
118118
- typing_utils =0.1.*
119-
- urllib3<2.0
119+
- urllib3>=2.3,<3
120120
- watchdog =3.0.*
121121
- websockets
122122
test:

ci/scripts/github/docs.sh

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,11 @@ ${MORPHEUS_ROOT}/scripts/fetch_data.py fetch docs examples
4444
rapids-logger "Configuring for docs"
4545
cmake ${CMAKE_BUILD_ALL_FEATURES} -DCMAKE_INSTALL_PREFIX=${CONDA_PREFIX} -DMORPHEUS_PYTHON_BUILD_STUBS=OFF -DMORPHEUS_BUILD_DOCS=ON .
4646

47-
rapids-logger "Building docs"
47+
rapids-logger "Installing Morpheus"
4848
cmake --build ${BUILD_DIR} --parallel ${PARALLEL_LEVEL} --target install
49-
cmake --build ${BUILD_DIR} --parallel ${PARALLEL_LEVEL} --target morpheus_docs
5049

51-
rapids-logger "Checking documentation links"
52-
cmake --build ${BUILD_DIR} --parallel ${PARALLEL_LEVEL} --target morpheus_docs_linkcheck
50+
rapids-logger "Building docs"
51+
cmake --build ${BUILD_DIR} --parallel ${PARALLEL_LEVEL} --target morpheus_docs morpheus_docs_linkcheck
5352

5453
rapids-logger "Archiving the docs"
5554
tar cfj "${WORKSPACE_TMP}/docs.tar.bz" ${BUILD_DIR}/docs/html

conda/environments/all_cuda-128_arch-aarch64.yaml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ dependencies:
1616
- beautifulsoup4=4.12
1717
- benchmark=1.8.3
1818
- boto3=1.35
19-
- breathe=4.35.0
19+
- breathe>=4.36
2020
- c-ares=1.32
2121
- ccache
2222
- clangdev=16
@@ -39,10 +39,9 @@ dependencies:
3939
- cython=3.0
4040
- datacompy=0.13.1
4141
- dill=0.3.7
42-
- docker-py=5.0
42+
- docker-py>=7.1,<8
4343
- doxygen=1.9.2
4444
- elasticsearch==8.9.0
45-
- exhale=0.3.6
4645
- feedparser=6.0
4746
- flake8
4847
- git-lfs
@@ -66,10 +65,10 @@ dependencies:
6665
- librdkafka=2.6.1
6766
- libtool
6867
- libwebp=1.3.2
69-
- libzlib >=1.3.1,<2
68+
- libzlib>=1.3.1,<1.4
7069
- mlflow>=2.10.0,<2.18
7170
- mrc=25.06
72-
- myst-parser=0.18.1
71+
- myst-parser>=4.0
7372
- nbsphinx
7473
- networkx=2.8.8
7574
- ninja=1.11
@@ -104,19 +103,19 @@ dependencies:
104103
- rdma-core>=48
105104
- requests-cache=1.1
106105
- requests-toolbelt=1.0
107-
- requests<2.29.0
106+
- requests>=2.32.3,<3
108107
- s3fs=2024.10
109108
- scikit-build=0.17.6
110109
- scikit-learn=1.3.2
111-
- sphinx
112-
- sphinx_rtd_theme
110+
- sphinx-copybutton>=0.5
111+
- sphinx>=8.2
113112
- sqlalchemy<2.0
114113
- sysroot_linux-64>=2.28
115114
- tqdm=4
116115
- transformers=4.36.2
117116
- tritonclient=2.34
118117
- typing_utils=0.1
119-
- urllib3<2.0
118+
- urllib3>=2.3,<3
120119
- versioneer
121120
- versioneer-518
122121
- watchdog=3.0
@@ -129,6 +128,7 @@ dependencies:
129128
- databricks-cli < 0.100
130129
- databricks-connect
131130
- dgl
131+
- exhale>=0.3.7
132132
- faiss-cpu
133133
- google-search-results==2.4
134134
- gpudb>=7.2.2.3
@@ -137,8 +137,9 @@ dependencies:
137137
- langchain==0.1.16
138138
- nemollm==0.3.5
139139
- newspaper3k==0.2.8
140+
- nvidia-sphinx-theme>=0.0.7
140141
- pypdfium2==4.30
141-
- pytest-kafka==0.6.0
142+
- pytest-kafka[kafka-python-ng]>=0.8,<0.9
142143
- python-logging-loki
143144
- sentence-transformers==2.7
144145
- torch==2.4.0

conda/environments/all_cuda-128_arch-x86_64.yaml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ dependencies:
1616
- beautifulsoup4=4.12
1717
- benchmark=1.8.3
1818
- boto3=1.35
19-
- breathe=4.35.0
19+
- breathe>=4.36
2020
- c-ares=1.32
2121
- ccache
2222
- clangdev=16
@@ -39,10 +39,9 @@ dependencies:
3939
- cython=3.0
4040
- datacompy=0.13.1
4141
- dill=0.3.7
42-
- docker-py=5.0
42+
- docker-py>=7.1,<8
4343
- doxygen=1.9.2
4444
- elasticsearch==8.9.0
45-
- exhale=0.3.6
4645
- feedparser=6.0
4746
- flake8
4847
- git-lfs
@@ -67,10 +66,10 @@ dependencies:
6766
- librdkafka=2.6.1
6867
- libtool
6968
- libwebp=1.3.2
70-
- libzlib >=1.3.1,<2
69+
- libzlib>=1.3.1,<1.4
7170
- mlflow>=2.10.0,<2.18
7271
- mrc=25.06
73-
- myst-parser=0.18.1
72+
- myst-parser>=4.0
7473
- nbsphinx
7574
- networkx=2.8.8
7675
- newspaper3k==0.2.8
@@ -107,19 +106,19 @@ dependencies:
107106
- rdma-core>=48
108107
- requests-cache=1.1
109108
- requests-toolbelt=1.0
110-
- requests<2.29.0
109+
- requests>=2.32.3,<3
111110
- s3fs=2024.10
112111
- scikit-build=0.17.6
113112
- scikit-learn=1.3.2
114-
- sphinx
115-
- sphinx_rtd_theme
113+
- sphinx-copybutton>=0.5
114+
- sphinx>=8.2
116115
- sqlalchemy<2.0
117116
- sysroot_linux-64>=2.28
118117
- tqdm=4
119118
- transformers=4.36.2
120119
- tritonclient=2.34
121120
- typing_utils=0.1
122-
- urllib3<2.0
121+
- urllib3>=2.3,<3
123122
- vale-styles-microsoft
124123
- vale-styles-write-good
125124
- vale=3.7
@@ -135,6 +134,7 @@ dependencies:
135134
- databricks-cli < 0.100
136135
- databricks-connect
137136
- dgl
137+
- exhale>=0.3.7
138138
- faiss-cpu
139139
- google-search-results==2.4
140140
- gpudb>=7.2.2.3
@@ -143,8 +143,9 @@ dependencies:
143143
- langchain==0.1.16
144144
- milvus==2.3.5
145145
- nemollm==0.3.5
146+
- nvidia-sphinx-theme>=0.0.7
146147
- pymilvus==2.3.6
147-
- pytest-kafka==0.6.0
148+
- pytest-kafka[kafka-python-ng]>=0.8,<0.9
148149
- python-logging-loki
149150
- sentence-transformers==2.7
150151
- torch==2.4.0+cu124

conda/environments/dev_cuda-128_arch-aarch64.yaml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ dependencies:
1313
- automake=1.16.5
1414
- beautifulsoup4=4.12
1515
- benchmark=1.8.3
16-
- breathe=4.35.0
16+
- breathe>=4.36
1717
- c-ares=1.32
1818
- ccache
1919
- clangdev=16
@@ -32,10 +32,9 @@ dependencies:
3232
- cython=3.0
3333
- datacompy=0.13.1
3434
- dill=0.3.7
35-
- docker-py=5.0
35+
- docker-py>=7.1,<8
3636
- doxygen=1.9.2
3737
- elasticsearch==8.9.0
38-
- exhale=0.3.6
3938
- feedparser=6.0
4039
- flake8
4140
- git-lfs
@@ -55,10 +54,10 @@ dependencies:
5554
- librdkafka=2.6.1
5655
- libtool
5756
- libwebp=1.3.2
58-
- libzlib >=1.3.1,<2
57+
- libzlib>=1.3.1,<1.4
5958
- mlflow>=2.10.0,<2.18
6059
- mrc=25.06
61-
- myst-parser=0.18.1
60+
- myst-parser>=4.0
6261
- nbsphinx
6362
- networkx=2.8.8
6463
- ninja=1.11
@@ -87,17 +86,17 @@ dependencies:
8786
- rapids-dask-dependency=25.02
8887
- rdma-core>=48
8988
- requests-cache=1.1
90-
- requests<2.29.0
89+
- requests>=2.32.3,<3
9190
- scikit-build=0.17.6
9291
- scikit-learn=1.3.2
93-
- sphinx
94-
- sphinx_rtd_theme
92+
- sphinx-copybutton>=0.5
93+
- sphinx>=8.2
9594
- sqlalchemy<2.0
9695
- sysroot_linux-64>=2.28
9796
- tqdm=4
9897
- tritonclient=2.34
9998
- typing_utils=0.1
100-
- urllib3<2.0
99+
- urllib3>=2.3,<3
101100
- versioneer
102101
- versioneer-518
103102
- watchdog=3.0
@@ -107,8 +106,10 @@ dependencies:
107106
- --extra-index-url https://download.pytorch.org/whl/cu124
108107
- databricks-cli < 0.100
109108
- databricks-connect
109+
- exhale>=0.3.7
110110
- gpudb>=7.2.2.3
111+
- nvidia-sphinx-theme>=0.0.7
111112
- pypdfium2==4.30
112-
- pytest-kafka==0.6.0
113+
- pytest-kafka[kafka-python-ng]>=0.8,<0.9
113114
- torch==2.4.0
114115
name: dev_cuda-128_arch-aarch64

conda/environments/dev_cuda-128_arch-x86_64.yaml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ dependencies:
1313
- automake=1.16.5
1414
- beautifulsoup4=4.12
1515
- benchmark=1.8.3
16-
- breathe=4.35.0
16+
- breathe>=4.36
1717
- c-ares=1.32
1818
- ccache
1919
- clangdev=16
@@ -32,10 +32,9 @@ dependencies:
3232
- cython=3.0
3333
- datacompy=0.13.1
3434
- dill=0.3.7
35-
- docker-py=5.0
35+
- docker-py>=7.1,<8
3636
- doxygen=1.9.2
3737
- elasticsearch==8.9.0
38-
- exhale=0.3.6
3938
- feedparser=6.0
4039
- flake8
4140
- git-lfs
@@ -56,10 +55,10 @@ dependencies:
5655
- librdkafka=2.6.1
5756
- libtool
5857
- libwebp=1.3.2
59-
- libzlib >=1.3.1,<2
58+
- libzlib>=1.3.1,<1.4
6059
- mlflow>=2.10.0,<2.18
6160
- mrc=25.06
62-
- myst-parser=0.18.1
61+
- myst-parser>=4.0
6362
- nbsphinx
6463
- networkx=2.8.8
6564
- ninja=1.11
@@ -89,17 +88,17 @@ dependencies:
8988
- rapids-dask-dependency=25.02
9089
- rdma-core>=48
9190
- requests-cache=1.1
92-
- requests<2.29.0
91+
- requests>=2.32.3,<3
9392
- scikit-build=0.17.6
9493
- scikit-learn=1.3.2
95-
- sphinx
96-
- sphinx_rtd_theme
94+
- sphinx-copybutton>=0.5
95+
- sphinx>=8.2
9796
- sqlalchemy<2.0
9897
- sysroot_linux-64>=2.28
9998
- tqdm=4
10099
- tritonclient=2.34
101100
- typing_utils=0.1
102-
- urllib3<2.0
101+
- urllib3>=2.3,<3
103102
- vale-styles-microsoft
104103
- vale-styles-write-good
105104
- vale=3.7
@@ -112,9 +111,11 @@ dependencies:
112111
- --extra-index-url https://download.pytorch.org/whl/cu124
113112
- databricks-cli < 0.100
114113
- databricks-connect
114+
- exhale>=0.3.7
115115
- gpudb>=7.2.2.3
116116
- milvus==2.3.5
117+
- nvidia-sphinx-theme>=0.0.7
117118
- pymilvus==2.3.6
118-
- pytest-kafka==0.6.0
119+
- pytest-kafka[kafka-python-ng]>=0.8,<0.9
119120
- torch==2.4.0+cu124
120121
name: dev_cuda-128_arch-x86_64

conda/environments/examples_cuda-128_arch-aarch64.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ dependencies:
2020
- cupy<13.4
2121
- datacompy=0.13.1
2222
- dill=0.3.7
23-
- docker-py=5.0
23+
- docker-py>=7.1,<8
2424
- elasticsearch==8.9.0
2525
- feedparser=6.0
2626
- grpcio
@@ -52,15 +52,15 @@ dependencies:
5252
- rapids-dask-dependency=25.02
5353
- requests-cache=1.1
5454
- requests-toolbelt=1.0
55-
- requests<2.29.0
55+
- requests>=2.32.3,<3
5656
- s3fs=2024.10
5757
- scikit-learn=1.3.2
5858
- sqlalchemy<2.0
5959
- tqdm=4
6060
- transformers=4.36.2
6161
- tritonclient=2.34
6262
- typing_utils=0.1
63-
- urllib3<2.0
63+
- urllib3>=2.3,<3
6464
- watchdog=3.0
6565
- websockets
6666
- pip:

conda/environments/examples_cuda-128_arch-x86_64.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ dependencies:
2020
- cupy<13.4
2121
- datacompy=0.13.1
2222
- dill=0.3.7
23-
- docker-py=5.0
23+
- docker-py>=7.1,<8
2424
- elasticsearch==8.9.0
2525
- feedparser=6.0
2626
- grpcio
@@ -54,15 +54,15 @@ dependencies:
5454
- rapids-dask-dependency=25.02
5555
- requests-cache=1.1
5656
- requests-toolbelt=1.0
57-
- requests<2.29.0
57+
- requests>=2.32.3,<3
5858
- s3fs=2024.10
5959
- scikit-learn=1.3.2
6060
- sqlalchemy<2.0
6161
- tqdm=4
6262
- transformers=4.36.2
6363
- tritonclient=2.34
6464
- typing_utils=0.1
65-
- urllib3<2.0
65+
- urllib3>=2.3,<3
6666
- watchdog=3.0
6767
- websockets
6868
- pip:

0 commit comments

Comments
 (0)