generated from pypa/sampleproject
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Contributors: Snake charmers 🐍 | ||
|
||
Contributions to the project can be seen `here <https://github.com/paquiteau/snake-fmri/graphs/contributors>`_ | ||
|
||
<a href="https://github.com/paquiteau/snake-fmri/graphs/contributors"> | ||
<img src="https://contrib.rocks/image?repo=paquiteau/snake-fmri" /> | ||
</a> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Developing SNAKE {#developing-snake} | ||
## Development environment {#developement-environment} | ||
|
||
We recommend to use a virtual environment, and install SNAKE-FMRI and | ||
its dependencies in it. | ||
|
||
|
||
## Running tests {#running-tests} | ||
|
||
|
||
## Writing documentation {#writing-documentation} | ||
|
||
Documentation is available online at | ||
<https://paquiteau.github.io/snake-fmri> | ||
|
||
It can also be built locally : | ||
|
||
```shell | ||
cd snake | ||
pip install -e .[doc] | ||
python -m sphinx docs docs_build | ||
``` | ||
|
||
To view the html doc locally you can use : | ||
|
||
```shell | ||
python -m http.server --directory docs_build 8000 | ||
``` | ||
|
||
And visit `localhost:8000` on your web browser. | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# License | ||
|
||
```{include} ../../LICENSE.txt | ||
``` |