Docs: more explicit make command names #385
Merged
Conversation
This file contains hidden or 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
There was some confusion arising from the fact that `make docs` did not build the local docs. To avoid this confusion in the future, the naming is made more explicit with the following changes: make local -> make local-docs make docs -> make production-docs make docs-sequential -> make production-docs-sequential The documentation and the GitHub actions are adapted as well.
han-ol
approved these changes
Apr 7, 2025
Collaborator
han-ol
left a comment
han-ol
left a comment
There was a problem hiding this comment.
Thanks! Renaming this is a good idea. I don't think you missed an occurrence. Should be good to go.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
There was some confusion arising from the fact that
make docsdid not build the local docs. To avoid this confusion in the future, the naming is made more explicit with the following changes:make local -> make local-docs
make docs -> make production-docs
make docs-sequential -> make production-docs-sequential
The documentation and the GitHub actions are adapted as well.
This PR also includes a minor fix in the
make.bat, where the jump label forlocalwas wrong.