Add editable tip and docs typo fix to README #2568
Open
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
pamelafox
changed the title
pamelafox
commented
Nov 13, 2024
| @@ -98,20 +98,32 @@ should be included, feel free to make the changes and submit a *pull-request*. | |||
|
|
|||
| To build the docs in your local environment, from the project directory: | |||
|
|
|||
| tox -e docs-html | |||
| ```bash | |||
| tox -e docs | |||
There was a problem hiding this comment.
docs-html doesn't exist
pamelafox
commented
Nov 13, 2024
| If you are contributing a bug fix or a new feature, you can install the app in editable mode: | ||
|
|
||
| ```shell | ||
| pip install -e . |
There was a problem hiding this comment.
Or should we do ".[all]"?
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.
To help contributors out who don't understand why they don't see their changes taking effect, I've added a tip about how to install in editable mode. I didn't include the extras, but that should okay if they're not changing the extras (i.e. the extras will be there from the example installation).
I also added backticks as the Markdown lint VS Code extension recommends it, and it leads to better syntax highlighting in VS Code. But I can remove if you prefer indented style. The README currently uses a mix.