[WIP] Updating developer information with docs building instructions #1582
Conversation
| In order to use Sourmash in the command line interface or the API while developing, you will need to install it in your enviornment in editable mode by running | ||
|
|
||
| ``` | ||
| pip install -e . |
There was a problem hiding this comment.
| pip install -e . | |
| pip install -e ".[test]" |
ref #1482
There was a problem hiding this comment.
actually, I'm not certain if you can do this with just this command, or if you need both...
There was a problem hiding this comment.
@luizirber can you please post your recommended set of commands using tox?
There was a problem hiding this comment.
I use tox -e docs for building the Python docs, and I don't use editable mode. If needed, then I use
tox -e dev
and follow the instructions for activating the new environment (usually
source .tox/dev/bin/activate
but can be
conda activate .tox/dev
for people using tox-conda)
Codecov Report
@@ Coverage Diff @@
## latest #1582 +/- ##
==========================================
+ Coverage 81.10% 89.28% +8.18%
==========================================
Files 102 75 -27
Lines 10334 6626 -3708
Branches 1171 1171
==========================================
- Hits 8381 5916 -2465
+ Misses 1748 505 -1243
Partials 205 205
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
Co-authored-by: Luiz Irber <luizirber@users.noreply.github.com>
Codecov Report
@@ Coverage Diff @@
## latest #1582 +/- ##
===========================================
+ Coverage 66.47% 89.34% +22.86%
===========================================
Files 27 76 +49
Lines 3708 6717 +3009
Branches 0 1198 +1198
===========================================
+ Hits 2465 6001 +3536
+ Misses 1243 507 -736
- Partials 0 209 +209
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
This PR to update the developer information page with:
- How to build Python and Rust docs?
- How to install Sourmash in editable mode?