-
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
Documentation UX revamp and internal CMake docbuild restructuring #2544
Conversation
Since building the user documentation brings in a lot of additional build time and dependencies, that need to be installed from different source (apt, pip, built from source, ...) and the ReadTheDocs documentation is more accessible, and more convenient, we opted to turn off the local build of the documentation. |
@Helveg thanks for this PR
the devdoc flag does not elicit any errors. |
I can't reproduce this. Do you have the proper file permissions to execute |
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 @Helveg I just have a few changes
doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst
Outdated
Show resolved
Hide resolved
doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst
Show resolved
Hide resolved
doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst
Outdated
Show resolved
Hide resolved
doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst
Outdated
Show resolved
Hide resolved
doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst
Outdated
Show resolved
Hide resolved
doc/htmldoc/developer_space/workflows/documentation_workflow/user_documentation_workflow.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: jessica-mitchell <mitchell20j@gmail.com>
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 lgtm!
This PR aims to present users with a simple streamlined approach to building the documentation. A user requests which documentation they are interested in by toggling CMake flags for documentation types aimed at certain target audiences, and CMake figures out which documentation targets need to be configured for that. Documentation is generated either implicitly upon installation (
make install
), or explicitly by usingmake docs
, or any of the subtargets, but the subtargets aren't considered public features.Documentation targets are:
sphinxdocs
: Uses Sphinx to generate the html documentation, and lots of stuff happens, see comment in code.doxygendocs
: Uses Doxygen to generate the dev docs.Documentation flags are:
with-userdoc
: Toggles the user documentation, on by default.with-devdoc
: Toggles the developer documentation, off by default.User stories
-Dwith-userdoc=OFF
-Dwith-devdoc=ON
make docs
instead ofmake install
closes #1905