Add package build doc #32
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
lymereJ
approved these changes
Apr 26, 2024
|
|
||
| ## Install `poetry` | ||
| ``` | ||
| curl -sSL https://install.python-poetry.org | python3 - |
There was a problem hiding this comment.
Should we also add instructions for Windows? Or at least specify that this is for Unix?
lymereJ
reviewed
Apr 26, 2024
Comment on lines
+39
to
+44
| # Build the Documentation locally | ||
|
|
||
| - Install sphinx: `pip install sphinx==7.3.7` | ||
| - Build documentation: `poetry run sphinx-build .\docs\source\ .\docs\` | ||
|
|
||
| This will create all the `*.html` files in the `.\docs` folder. |
There was a problem hiding this comment.
I added instruction on how to build the documentation since I've been working on updating it.
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.
Add developer's guide for packaging and publishing constrain with poetry. Repackaging constrain is needed for all backends / GUI updates during local testing.