-
Notifications
You must be signed in to change notification settings - Fork 384
Add note about failure modes when using sphinx-build #3507
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
Add note about failure modes when using sphinx-build #3507
Conversation
doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst
Outdated
Show resolved
Hide resolved
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.
Great! thanks for adding this note @elide-b , I have a couple of suggestions for improvements :)
doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst
Outdated
Show resolved
Hide resolved
…ser_documentation_workflow.rst
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.
Thanks @elide-b lgtm
Merging with 1 reviewer as its documentation related |
Running the documentation build from different working directories, or placing the build directory inside of the source directory causes strange failures (see below), which for most Sphinx builds is the default layout, so I've added a note to clarify that for the NEST doc build that is not a suitable option ✨