Add "Build the doc" section in the readme #941
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
Signed-off-by: CARON Alice <[email protected]>
|
|
flo-dup
reviewed
Feb 7, 2025
There was a problem hiding this comment.
The drawback of putting it in a separate README.md is that you need to describe the two options (terminal / IDE GUI) instead of a single one. See https://github.com/powsybl/powsybl-core/blob/main/docs/README.md for an example.
Besides you get an annoying warning each time you build the docs, as the README.md is not included in the toctree.
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.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce?
Regroup all the documentation instructions in a docs/README.md file and link it from the main README file.
Now the documentation should be built in the docs/_build folder with the
makeorsphinxcommands.