Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Building MyGrad's Docs

Install the the following:
Install the following:

```shell
pip install sphinx
pip install sphinx_rtd_theme
pip install nbsphinx
pip install numpydoc
pip install matplotlib
pip install pydata_sphinx_theme
```

To build the docs for the first time, navigate to `mygrad/docs/source/`
Expand All @@ -16,6 +18,12 @@ and generate the proper `.rst` files via:
sphinx-autogen -o generated/ *.rst
```

In the case of Windows, Powershell might have trouble with the wildcard, so use:

```shell
Get-ChildItem -Filter "*.rst" | ForEach-Object { sphinx-autogen -o generated/ $_.FullName }
```

Then navigate to `mygrad/docs/` and run:

```shell
Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ numba==0.60.0
sphinx==7.0.1
numpydoc==1.5.0
pydata-sphinx-theme==0.13.3
matplotlib==3.6.3
matplotlib==3.6.3
sphinx-copybutton==0.5.2
3 changes: 2 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"sphinx.ext.viewcode",
"sphinx.ext.githubpages",
"sphinx.ext.autosummary",
"sphinx_copybutton",
"matplotlib.sphinxext.plot_directive",
"numpydoc",
]
Expand Down Expand Up @@ -221,4 +222,4 @@ def setup(app):
# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"https://docs.python.org/": None}
intersphinx_mapping = {"python": ("https://docs.python.org/", None)}