Enable nit-picky mode in documentation and fix associated warnings#1753
Enable nit-picky mode in documentation and fix associated warnings#1753j9ac9k merged 9 commits intopyqtgraph:masterfrom
Conversation
|
As of right now, these are the only warnings I'm getting |
ixjlyons
left a comment
There was a problem hiding this comment.
Definitely a fan of the restructuring. This has been on my mind for a while I just never got around to doing it. Looks good overall.
doc/source/user_guide/index.rst
Outdated
| exporting | ||
| prototyping | ||
|
|
||
| The following is a user guide for using portions of the library |
.gitignore
Outdated
|
|
||
| # Sphinx documentation | ||
| docs/_build/ | ||
| doc/source/_build |
There was a problem hiding this comment.
I think this is covered by the build/ entry up above. The docs get built in doc/build per the Makefile/make.bat. There's even another entry to ignore the docs build on line 24.
|
|
||
| Contents: | ||
|
|
||
| .. toctree:: |
There was a problem hiding this comment.
Here is where I'd put a hidden toctree referring to the top-level sections. This is the cause of the warnings about those pages not being included in a toctree. Since we already have the new panels, we don't really need to show the actual toctree, so this should do it (also makes the top nav bar work):
.. toctree::
:hidden:
getting_started/index
user_guide/index
debug
development/index
api_reference/indexNot sure what the best ordering is.
|
This PR enabled nit-picky mode, and I'm working on addressing the warnings that stem from that... there are still 93 warnings, so far from complete. |
|
If anyone else is feeling bored and wants to bring the nit-picky warning/error count down, feel free to push changes to this branch :D |
|
RTD passed CI 🎊 |
|
Cancelled CI run, one job was hanging a bit, going to merge as is. Thanks @ixjlyons for your help! |
This PR is just a start, and I would welcome any input; other maintainers are encouraged to push changes to this branch should they feel a change is worthwhile.
This PR starts with
doc/listmissing.py, which attempts to identify portions of pyqtgraph that are undocumented..gitignoreto ignore the build directory.ColorMapWidgetdocumentation linksAfter that, this PR attempts to restructure existing documentation into 4 distinct sections.
The main
index.htmlpage is now using panels (heavily borrowed the idea from pandas: https://pandas.pydata.org/docs/ ). The rest of the changes in this diff has to do with shifting around the relevant