DOC: Update to docs to use rtd theme and remove python 2 from docs. #893
Conversation
|
|
|
Still need to do some minor edits, so not merging yet. |
|
@rcjackson whenever you get time, know your busy with AMS. The docs now pass, but there are alot of warnings that I'm seeing. Not sure if you've seen these before? |
zssherman
force-pushed
the
doc_rtd_enhancement
branch
from
def8536 to
7d1a7d4
Compare
zssherman
changed the title
|
It looks like you have .rst files that are not being referenced to in the documentation. I would double check to ensure that you're not missing any of those modules. |
|
Hmm all the rst files seem to be there in the source and generated directory, which is why I'm a little lost. |
|
But the warning seems to be for every single file, which almost seems like a format issue or something, but not sure honestly. |
doc/source/index.rst
Outdated
| .. toctree:: | ||
| :maxdepth: 4 | ||
| :maxdepth: 1 |
There was a problem hiding this comment.
I think it's whining about this. Try setting it back to 4.
There was a problem hiding this comment.
Gotcha, will try that
There was a problem hiding this comment.
@rcjackson Dang, sadly did not work.
There was a problem hiding this comment.
If you try to access one of those functions in the docs can you still get to it? I just would like to know how important these warnings actually are, so this will tell me.
There was a problem hiding this comment.
Yeah it seems I can navigate through all the functions and their attributes and everything are there. One thing I notices is params show up as gate_yarray instead of gate_y: array so wondering if the old docs all colons need a space removed from before the colon
There was a problem hiding this comment.
In PyDDA I only put a space after the colon, not before. So that might be causing it to not work with this theme. I recall we ran into something similar with ACT.
There was a problem hiding this comment.
Gotcha, I'll go through and change all of that.
This avoids sphinxrtdtheme parameter colon spacing issue and removes numpydoc python 2.
functions, modules and classes.
cross reference and duplication as they are now autogenerated.
|
I thin this is almost done. Most if not all warnings are fixed, examples are up to date. The only thing I can't figure out is why the custom Py-ART exceptions are not documenting. My only guess is the _templates aren't designed for how those classes are set up. |
|
@rcjackson @scollis Think this is as good as I can get it, if you both want to review one last time. |
|
From what you have showed me, this should be good to go. |
|
Cool, thanks @rcjackson merging. |
Still going to do minor edits.