DOC: Fix instructions to set up dev env, fixes #591 #592
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
In contributors.rst. Also use 'sphinx.ext.autosectionlabel' in doc/conf.py
|
Hi @ItamarFruchter @yardencsGitHub can you check out this fixed version of the docs for setting up a dev environment and let me know if it's clearer? Thank you 🙏 |
Codecov ReportBase: 93.21% // Head: 93.21% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #592 +/- ##
=======================================
Coverage 93.21% 93.21%
=======================================
Files 66 66
Lines 2461 2461
=======================================
Hits 2294 2294
Misses 167 167 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
I will go ahead and merge but please still do give me feedback |
|
@all-contributors please add @ItamarFruchter for docs |
|
I've put up a pull request to add @ItamarFruchter! 🎉 |
NickleDave
added a commit
that referenced
this pull request
Nov 19, 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.
Fix instructions to set up dev env in contributors.rst. Fixes #591.
Also use 'sphinx.ext.autosectionlabel' in doc/conf.py