Skip to content

Commit

Permalink
doc: Document how to add a tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin ABEL authored and n-riesco committed May 8, 2015
1 parent 7cf84af commit 1132793
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ lsb_release -sd
of a pull request acknowledges their consent. To express this consent, please,
ensure the AUTHORS file has been updated accordingly.

- New functionalities should be documented, for this you can create tutorials as
markdown or ipython notebook format in the folder `doc/md` or `doc/ipynb`.
Then add a link to this tutorial in the `_navbar.tpl` jinja template and
regenerate the doc with `npm run doc` to see the result.

## Coding guidelines

- For the sake of readability, please, ensure the coding style of your pull
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,14 @@ Please, refer to the [usage notes](http://n-riesco.github.io/ijavascript/usage.h

## Documentation

The ijavscript code is documented using [jsdoc](http://usejsdoc.org/).
You can build the documentation for this package with the command `npm run doc`.
To run this command you'll need to install ipython on your system as it uses
nb convert to convert ipython notebooks to html files.

Currently, the documentation is hosted on the gh-pages branch on github, you can
view it here: <http://n-riesco.github.io/ijavascript/>

The IJavascript code is documented using [jsdoc](http://usejsdoc.org/).
You can build the documentation for this package with the command `npm run doc`.
To run this command you'll need to install `ipython` on your system as it uses
`nbconvert` to convert ipython notebooks to html files.

# Contributions

First of all, thank you for taking the time to contribute. Please, read
Expand Down

0 comments on commit 1132793

Please sign in to comment.