Fix sphinx warnings and use readthedocs theme for local doc generation#297
Conversation
|
Looks fine to me. It's probably not important, but FYI: with Python 3.7 and Sphinx 2.0.1, the only python-sphinx variant I tried, I get this warning when building docs: |
|
Thought I found the problem (a stray "frd" in On MacOS (where I usually work), the file system is "case preserving" but not "case sensitive". This is a problem when you have two functions with the same name but different case. In the There was an error that was getting masked by this effect: in the documentation, we need to reference both @roryyorke Can you check to see if this fix works for you (on windows or linux, I assume). |
|
No more warning due to FRD/frd, and I can see both control.frd and control.FRD in the generated docs. |
This PR fixes up some warnings that were being generated by
sphinxand changes the default theme used for generated the documentation on a local machine to match the ReadTheDocs theme that is used online (handy so that you know what things will look like when rendered on ReadTheDocs).In fixing up one of the warning messages in
statesp.py, I also took the opportunity to update other docstrings to be numpydoc compatible.