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 #1510

Closed
sarakonradi opened this issue Apr 8, 2020 · 0 comments · Fixed by #1518
Closed

Fix sphinx-build warnings #1510

sarakonradi opened this issue Apr 8, 2020 · 0 comments · Fixed by #1518
Assignees
@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: Enhancement New functionality, model or documentation

Comments

@sarakonradi
Copy link
Contributor

Currently, generating documentation locally with Sphinx involves activating the nest-doc environment and entering make html: https://nest-simulator.readthedocs.io/en/latest/documentation_workflow/user_documentation_workflow.html

The HTML pages are rendered well. However, numerous warnings are emitted in the process. These relate to formatting issues, broken links, incomplete references, etc.

We have begun working on these warnings in @steffengraber's cleanup-doc branch.
@sarakonradi sarakonradi mentioned this issue Apr 17, 2020
Merged
@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: Enhancement New functionality, model or documentation labels Apr 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@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: Enhancement New functionality, model or documentation
Projects
Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix sphinx-build warnings steffengraber/nest-simulator
2 participants
@heplesser @sarakonradi