Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix sphinx-build warnings #1518

Merged
merged 52 commits into from
Nov 10, 2020
Merged

Fix sphinx-build warnings #1518

merged 52 commits into from
Nov 10, 2020

Conversation

sarakonradi
Copy link
Contributor

Fixes #1510

Currently, numerous warnings are emitted when generating HTML with Sphinx locally.

The majority of these warnings are related to the model files and could disappear with the merge of #1374. This is because files (e.g., doc/models/create_models.rst) that result in toctree warnings will anyhow be deleted in the other PR.

Given this information, the current PR has begun to tackle the other documentation-related warnings.

steffengraber and others added 30 commits March 26, 2020 11:17
@steffengraber
Fix - WARNING: Title underline too short
585a221
@steffengraber
Fix - WARNING: Title underline too short
de354c2
@steffengraber
Fix - WARNING: Unknown target name: "synapse models"
f3a804e
@steffengraber
Fix - WARNING: toctree contains reference to nonexisting document 'to…
1df32ab 
…pology/index'
@steffengraber
Fix - WARNING: toctree contains reference to nonexisting document
9f4eb1f
@steffengraber
Changed links to ipynb downloads
4b1bcf3
@steffengraber
Fix - WARNING: Duplicate explicit target name
a85f6d6
@steffengraber
Fix - WARNING: toctree contains reference to nonexisting document
556701d
@sarakonradi
Fix WARNING: Unknown directive type 'subnet_rm' in 'guides/from_nest2…
acbdd85 
…_to_nest3
@sarakonradi
Fix WARNING: Unknown directive type 'model_rm' in 'guides/from_nest2_…
6de9d21 
…to_nest3
@sarakonradi
Fix WARNING: Unknown directive type 'function_rm' in 'guides/from_nes…
6d392d4 
…t2_to_nest3
@sarakonradi
Fix Title underline too short in 'models/conductance.rst'
ef7cd1d
@sarakonradi
Fix Title underline too short in 'models/current-based.rst'
cd63d2d
@sarakonradi
Fix Title underline too short in 'ref_material/nest2_vs_3.rst'
8567bd3
@sarakonradi
Fix WARNING: image file not readable in 'installation/index.rst'
d24381f
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'citing-nest.rst'
08bc037
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'connection-ge…
8d713ad 
…nerator-interface.rst'
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'contribute/ma…
95a63c5 
…iling_list_guidelines.rst'
@sarakonradi
Fix WARNING: toctree isn't included in any documents in 'example_temp…
bf44d31 
…late.rst'
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'pyapi_templat…
6b604b5 
…e.rst'
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'vim_support_s…
1ff5368 
…li.rst'
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'faqs/index.rst'
3912021
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'features.rst'
d04856b
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'glossary.rst'
b29f94c
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'pynest.rst'
6e91eb9
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'oldvers_insta…
4e49946 
…ll.rst'
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'microcircuit/…
fa4fc2e 
…index.rst'
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'README.rst'
7e05e71
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'an-introducti…
fa9a40f 
…on-to-sli.rst'
@sarakonradi
Fix WARNING: document isn't included in any toctree in 'first-steps.rst'
3d483f1
@heplesser heplesser requested review from heplesser and jhnnsnk April 20, 2020 08:49
@heplesser heplesser marked this pull request as draft April 20, 2020 08:50
@heplesser heplesser added I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. labels Apr 20, 2020
@heplesser heplesser added this to the NEST 3.0 milestone Apr 20, 2020
@sarakonradi sarakonradi mentioned this pull request Apr 22, 2020
Closed
24 tasks
@terhorstd
Copy link
Contributor

this would be nice to have for nest-3, but is in no way mandatory. removing from milestone.

@terhorstd terhorstd removed this from the NEST 3.0 milestone Jun 16, 2020
@stinebuu stinebuu requested review from stinebuu and jougs and removed request for heplesser and jhnnsnk November 9, 2020 10:05
@jougs
Copy link
Contributor

jougs commented Nov 9, 2020

During the current hackathon we decided that we should merge this as soon as possible to avoid endless merge conflicts and duplication of work in other branches. New warnings can then be addressed in new pull requests.

jougs
jougs requested changes Nov 9, 2020
View reviewed changes
Copy link
Contributor

@jougs jougs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing these. I think we can even do without the second review by @stinebuu, so I'm removing the request for review.

@jougs jougs removed the request for review from stinebuu November 9, 2020 22:40
@jougs jougs marked this pull request as ready for review November 9, 2020 22:40
@jougs
Copy link
Contributor

jougs commented Nov 9, 2020

Also, please resolve the conflicts. Thanks!

@sarakonradi @jougs
Apply suggestions from code review
b66df91 
Co-authored-by: Jochen Martin Eppler <[email protected]>
jougs
jougs approved these changes Nov 10, 2020
View reviewed changes
Copy link
Contributor

@jougs jougs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy if Travis is. Thanks for taking care!

@stinebuu stinebuu merged commit b9648c0 into nest:master Nov 10, 2020
@sarakonradi sarakonradi mentioned this pull request Feb 2, 2021
Closed
@steffengraber steffengraber deleted the cleanup-doc branch September 6, 2023 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jougs jougs jougs approved these changes

Assignees

@steffengraber steffengraber

@sarakonradi sarakonradi

Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fix sphinx-build warnings
6 participants
@sarakonradi @terhorstd @jougs @heplesser @steffengraber @stinebuu