Skip to content

Commit

Permalink
Sphinx panel
Browse files Browse the repository at this point in the history
Fixes pytorch#73835.

The full context for this is detailed in the issue, but briefly:

- Adds `sphinx-panel`

Other PRs will demonstrate usage.
Pull Request resolved: pytorch#73836
Approved by: https://github.com/albanD
  • Loading branch information
HaoZeke authored and pytorchmergebot committed Mar 7, 2022
1 parent 1d49711 commit 979a78f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ missing file warnings but will still complete. For example, to work on `jit.rst`

```bash
cd docs/source
ls | grep rst | grep -v index | grep -v jit | xargs rm
find . -type f | grep rst | grep -v index | grep -v jit | xargs rm

# Make your changes, build the docs, etc.

Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ tensorboard
# required to build torch.distributed.elastic.rendezvous.etcd* docs
python-etcd>=0.4.5
sphinx_copybutton
sphinx-panels
4 changes: 4 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,16 @@
'sphinxcontrib.katex',
'sphinx.ext.autosectionlabel',
'sphinx_copybutton',
'sphinx_panels'
]

# build the templated autosummary files
autosummary_generate = True
numpydoc_show_class_members = False

# Theme has bootstrap already
panels_add_bootstrap_css = False

# autosectionlabel throws warnings if section names are duplicated.
# The following tells autosectionlabel to not throw a warning for
# duplicated section names that are in different documents.
Expand Down

0 comments on commit 979a78f

Please sign in to comment.