Skip to content

Commit

Permalink
feat: add misc
Browse files Browse the repository at this point in the history
  • Loading branch information
paquiteau committed Feb 3, 2025
1 parent cef1d4c commit 1250fb7
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/misc/contributors.md
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>
31 changes: 31 additions & 0 deletions docs/misc/development.md
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.

4 changes: 4 additions & 0 deletions docs/misc/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# License

```{include} ../../LICENSE.txt
```

0 comments on commit 1250fb7

Please sign in to comment.