The Neuromod-wiki is available at the address: https://nmod-wiki.fcbg.ch Contributions in all forms are welcome. Please use the issue tracker to propose changes, additions and report issues and solutions found when working with neuromodulation data and equipment from our site.
Pull request to the repository are welcome. The wiki is organized as a python project with a sphinx documentation. The documentation, used to generate the website HTML pages, is written in reStructuredText format in the doc folder.
In a pull request, the automatic workflows will build the documentation and check for conformity. Any warnings and errors during the build process must be resolved before the pull request can be merged.
After cloning the repository, the project and its dependencies can be installed in a python environment with:
$ pip install -e path/to/nmod-wiki[all]
Additionally, pre-commit hooks are available to check for common errors before committing changes.
$ pip install pre-commit
$ pre-commit install
The documentation can be build from the nmod-wiki/doc folder with make commands:
make htmlto build the entire website.make html-noplotto build the website without running the tutorials.make cleanto remove the generated and build files.make viewto open the build website in the default browser.make linkcheckfollowed bymake linkcheck-grepto test for broken URLs.
Additional information can be found on the contributing guide.