Fix Sphinx warnings #157
Fix Sphinx warnings #157
Conversation
.gitignore
Outdated
There was a problem hiding this comment.
Added a line to .gitignore so I don't accidentally publish by docs environment
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Added the contents of install_developer.rst here for two reasons. First, it consolidates our scattered installation a bit. Secondly, it cleared the following warnings:
/home/sandboxes/vcatlett/repos/github/dysh/docs/source/for_developers/install_developer.rst:12: WARNING: duplicate label dysh1, other instance in /home/sandboxes/vcatlett/repos/github/dysh/docs/source/for_developers/install.rst
/home/sandboxes/vcatlett/repos/github/dysh/docs/source/for_developers/install_developer.rst:81: WARNING: duplicate label dysh2, other instance in /home/sandboxes/vcatlett/repos/github/dysh/docs/source/for_developers/install.rst
/home/sandboxes/vcatlett/repos/github/dysh/docs/source/for_developers/install_developer.rst:122: WARNING: duplicate label dysh3, other instance in /home/sandboxes/vcatlett/repos/github/dysh/docs/source/for_developers/install.rst
There was a problem hiding this comment.
See the comment on the changes to docs/source/for_developers/install.rst
There was a problem hiding this comment.
Added a space to resolve this error:
/home/sandboxes/vcatlett/repos/github/dysh/docs/source/getting_started/tutorials/GBT/index.rst:5: ERROR: Error in "toctree" directive:
invalid option block... toctree::
:maxdepth: 2
tutorial-positionswitch
| """ | ||
| Plot a spectrum using matplotlib | ||
| """ |
There was a problem hiding this comment.
Ah, I just added line breaks to the file's docstring because I think it looks better
There was a problem hiding this comment.
@tchamberlin & @vcatlett has this been resolved?
Co-authored-by: Thomas Chamberlin <[email protected]>
Small changes to fix
sphinx-autobuildwarnings. Will comment details on the individual changes.