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

Wrong path and link in user_documentation_workflow #1961

Closed
stinebuu opened this issue Mar 5, 2021 · 2 comments · Fixed by #1926
Closed

Wrong path and link in user_documentation_workflow #1961

stinebuu opened this issue Mar 5, 2021 · 2 comments · Fixed by #1926
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.

Comments

@stinebuu
Copy link
Contributor

stinebuu commented Mar 5, 2021

Describe the flaw
In the user_documentation_workflow on ReadTheDocs, https://nest-simulator.readthedocs.io/en/latest/documentation_workflow/user_documentation_workflow.html, it says that when you install documentation the rendered text can be found in <nest_install_dir>/share/doc/nest/html/

image

This folder is empty for me for newest master (for a clean build, and after doing make html and make install). I think the documentation can now be found in <nest_install_dir>/doc/userdoc/html/? So the path should be updated.

Also, there seems to be a broken link to an image further up on the page:
image
@jessica-mitchell jessica-mitchell mentioned this issue Mar 8, 2021
Merged
@jessica-mitchell
Copy link
Contributor

@stinebuu I think the paths will be correct as of #1926. When I last built nest from that branch, the install directory path for docs was /share/doc/nest/html/ and in the build directory the path was /doc/userdoc/html/.
The link though does need to be fixed, thanks!

@stinebuu stinebuu 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 Mar 10, 2021
@jougs
Copy link
Contributor

jougs commented Mar 16, 2021

The broken link is fixed by #1926 (commit d7e2006 in particular).

@jougs jougs linked a pull request Mar 16, 2021 that will close this issue
Fix PyNest help and helpdesk commands #1926
Merged
@jougs jougs mentioned this issue Mar 16, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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 a pull request may close this issue.

Fix PyNest help and helpdesk commands jougs/nest-simulator
3 participants
@jougs @jessica-mitchell @stinebuu