-
Notifications
You must be signed in to change notification settings - Fork 357
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clean up Sphinx warnings related to models #2236
Clean up Sphinx warnings related to models #2236
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazingly many details fixed! Thanks a lot!
Some double-backtics need a look, as discussed.
@terhorstd I addressed your comments, but since this was updating the double back ticks for some of the terms, I decided to go through and try find all terms that needed double back ticks and add them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This really fixes a lot of broken documentation! Much appreciated!!!
🚀
I have some small questions and comments just for clarification. Of course there are still tonnes of unquoted variables or math terms around, enough for such PRs in months to come. For this one we should however not take more changes into the set. Let's try to finish this one first, then eventually start a new one.
I just tried to build documentation from this branch. This failed because nest could not be imported with our fancy new way of managing the nest module in Python. Has anyone else seen this problem? The testsuite runs find and PyNEST works otherwise.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many thanks! This is really a great improvement. Above my suggestions, I have a feeling that there might be more variable names in the tsodyks_* files that need marking up.
@heplesser: This should be fixed by #2244. |
And just for the record: There is a certain potential for conflict with #2246. |
Co-authored-by: Jochen Martin Eppler <j.eppler@fz-juelich.de> Co-authored-by: Dennis Terhorst <terhorstd@users.noreply.github.com>
@jessica-mitchell: friendly ping! |
@jougs thanks for the reminder -I am working on this - Sphinx failed to build after the changes you or Dennis made in the extractor_userdocs.py were committed, so I'm trying to fix it (I have a fix, but I've noticed another issue, which I'm looking into) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The recent commits address all my concerns. Thanks again!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lots of improvements! Thanks for making the docs a better place! 👍
This PR resolves some of the warnings that Sphinx outputs related to models.
Many of the changes are related to items in the bibliography that were not cited properly.
There are also syntax fixes.
Because the restructured text files for models are autogenerated from a script, Sphinx warns that it doesnt' have them indexed.
So this PR also indexes the files by creating a JSON file from the extractor_userdocs.py that Sphinx reads and outputs in Jinja templated table of contents.
Fixes #1907