Skip to content

Commit

Permalink
DOC: add scientific python development guide (#259)
Browse files Browse the repository at this point in the history
* FIX: set `FORCE_COLOR` to `1` instead of `yes`
  • Loading branch information
shenvitor committed Mar 18, 2024
1 parent f46c4b7 commit dfc3a24
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -1002,6 +1002,7 @@ Do you have other recommendations? Edit this page
:::{rubric} Software development in Python
:::

- [Scientific Python Library Development Guide](https://learn.scientific-python.org/development/) for scientists and research software engineers.
- [Complete Python Development Guide ― testdriven.io](https://testdriven.io/guides/complete-python)
- _Effective Python: 90 Specific Ways to Write Better Python_ (2019) by Brett Slatkin
{cite}`slatkinEffectivePython902019`. See also
Expand Down
12 changes: 6 additions & 6 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ description =
Build documentation and API through Sphinx
passenv = *
setenv =
FORCE_COLOR = yes
FORCE_COLOR = 1

[testenv:doclive]
allowlist_externals =
Expand Down Expand Up @@ -48,7 +48,7 @@ description =
Set up a server to directly preview changes to the HTML pages
passenv = *
setenv =
FORCE_COLOR = yes
FORCE_COLOR = 1

[testenv:docnb]
allowlist_externals =
Expand All @@ -65,7 +65,7 @@ description =
passenv = *
setenv =
EXECUTE_NB = yes
FORCE_COLOR = yes
FORCE_COLOR = 1

[testenv:docnblive]
allowlist_externals =
Expand Down Expand Up @@ -94,7 +94,7 @@ description =
passenv = *
setenv =
EXECUTE_NB = yes
FORCE_COLOR = yes
FORCE_COLOR = 1

[testenv:docnb-force]
allowlist_externals =
Expand All @@ -105,7 +105,7 @@ description =
Execute ALL Jupyter notebooks and build documentation with Sphinx
passenv = *
setenv =
FORCE_COLOR = yes
FORCE_COLOR = 1
FORCE_EXECUTE_NB = yes
PYTHONHASHSEED = 0

Expand All @@ -131,7 +131,7 @@ description =
Check external links in the documentation (requires internet connection)
passenv = *
setenv =
FORCE_COLOR = yes
FORCE_COLOR = 1

[testenv:nb]
allowlist_externals =
Expand Down

0 comments on commit dfc3a24

Please sign in to comment.