[Docs] Fix documentation building instructions #25942
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pcmoritz
requested review from
maxpumperla,
richardliaw,
edoakes,
simon-mo and
ericl
as code owners
|
cc @maxpumperla |
richardliaw
reviewed
Jun 20, 2022
| @@ -16,7 +16,7 @@ pip install -r requirements-doc.txt | |||
| To compile the documentation and open it locally, run the following command from this directory. | |||
|
|
|||
| ```bash | |||
| make html && open _build/html/index.html | |||
| make develop && open _build/html/index.html | |||
There was a problem hiding this comment.
Can you also make sure to explicitly say that this is for development, and to reproduce build failures you should still run make html?
richardliaw
reviewed
Jun 20, 2022
| @@ -45,7 +45,7 @@ | |||
| "Building the documentation is done by running the following command:\n", | |||
| "\n", | |||
| "```shell\n", | |||
| "make html\n", | |||
| "make develop\n", | |||
richardliaw
approved these changes
Jun 20, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
It is often a bit challenging to get the full documentation to build (there are external packages that can make this challenging). This changes the instructions to treat warnings as warnings and not errors, which should improve the workflow.
make developis the same asmake htmlexcept it doesn't treat warnings as errors.Related issue number
Checks
scripts/format.shto lint the changes in this PR.