Skip to content

Commit fc0aef7

Browse files
Change python docs to pydata theme (#1785)
This PR changes docs theme from sphinx_rtd_theme to use pydata-theme: https://pydata-sphinx-theme.readthedocs.io/en/latest/ Authors: - GALI PREM SAGAR (https://github.com/galipremsagar) - Brad Rees (https://github.com/BradReesWork) Approvers: - Brad Rees (https://github.com/BradReesWork) - AJ Schmidt (https://github.com/ajschmidt8) URL: #1785
1 parent 59f6fdd commit fc0aef7

35 files changed

+531
-526
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,6 @@ python/_external_repositories/
8181

8282
# created by Dask tests
8383
python/dask-worker-space
84+
85+
# Sphinx docs & build artifacts
86+
docs/cugraph/source/api_docs/api/*

SOURCEBUILD.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ conda env create --name cugraph_dev --file conda/environments/cugraph_dev_cuda11
4949
# for CUDA 11.2
5050
conda env create --name cugraph_dev --file conda/environments/cugraph_dev_cuda11.2.yml
5151

52+
# for CUDA 11.4
53+
conda env create --name cugraph_dev --file conda/environments/cugraph_dev_cuda11.4.yml
54+
55+
5256
# activate the environment
5357
conda activate cugraph_dev
5458

conda/environments/cugraph_dev_cuda11.0.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ dependencies:
3131
- faiss-proc=*=cuda
3232
- scikit-learn>=0.23.1
3333
- sphinx
34-
- sphinx_rtd_theme
34+
- pydata-sphinx-theme
3535
- sphinxcontrib-websupport
3636
- sphinx-markdown-tables
3737
- sphinx-copybutton

conda/environments/cugraph_dev_cuda11.2.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ dependencies:
3131
- faiss-proc=*=cuda
3232
- scikit-learn>=0.23.1
3333
- sphinx
34-
- sphinx_rtd_theme
34+
- pydata-sphinx-theme
3535
- sphinxcontrib-websupport
3636
- sphinx-markdown-tables
3737
- sphinx-copybutton

docs/cugraph/Makefile

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# You can set these variables from the command line.
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
7-
SPHINXPROJ = cuGraph
7+
SPHINXPROJ = cugraph
88
SOURCEDIR = source
99
BUILDDIR = build
1010
IMGDIR = images
@@ -18,5 +18,4 @@ help:
1818
# Catch-all target: route all unknown targets to Sphinx using the new
1919
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
2020
%: Makefile
21-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
22-
cp -r $(SOURCEDIR)/$(IMGDIR) $(BUILDDIR)/html
21+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/cugraph/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
# Building Documentation
22

3-
A basic python environment with packages listed in `./requirement.txt` is
4-
enough to build the docs. Doc generation does not get run by default
3+
All prerequisite for building docs are in the cugraph development conda environment.
4+
[See build instructions](../../SOURCEBUILD.md) on how to create the development conda environment
55

6-
## Get additional dependency
6+
## Steps to follow:
77

8-
```bash
9-
pip install -r requirement.txt
10-
```
8+
In order to build the docs, we need the conda dev environment from cugraph and we need to build cugraph from source.
9+
10+
1. Create a conda env and build cugraph from source. The dependencies to build rapids from source are installed in that conda environment, and then rapids is built and installed into the same environment.
11+
12+
2. Once cugraph is built from source, navigate to `../docs/cugraph/`. If you have your documentation written and want to turn it into HTML, run makefile:
1113

12-
## Run makefile:
1314

1415
```bash
16+
# most be in the /docs/cugraph directory
1517
make html
1618
```
1719

18-
Outputs to `build/html/index.html`
20+
This should run Sphinx in your shell, and outputs to `build/html/index.html`
21+
1922

2023
## View docs web page by opening HTML in browser:
2124

22-
First navigate to `/build/html/` folder, i.e., `cd build/html` and then run the following command:
25+
First navigate to `/build/html/` folder, and then run the following command:
2326

2427
```bash
2528
python -m http.server

docs/cugraph/requirement.txt

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

docs/cugraph/source/_static/copybutton.css

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

docs/cugraph/source/_static/copybutton_pydocs.js

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

docs/cugraph/source/_static/example_mod.js

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

0 commit comments

Comments
 (0)