Home
Julien Cohen-Adad edited this page Sep 16, 2020
·
5 revisions
Welcome to the shimming-toolbox-py wiki!
Some of the conventions below will have to move to a CONTRIBUTION file at some point:
- How to name variables
- https://www.python.org/dev/peps/pep-0008/#function-and-variable-names
- https://github.com/neuropoly/spinalcordtoolbox/wiki
You can build the documentation locally if you've installed the shimming-toolbox package in your virtualenv with the docs option. Follow the directions here to install the package with this option. This will install Sphinx and its dependencies, allowing you to build the docs locally and check that your docstrings are correctly formatted.
Then, you can cd to the docs/ directory in the repo and run make html. The HTML files will appear in docs/build/html/ where you'll find index.html. You can open index.html in your browser to navigate through your local build of the docs as they'll appear on ReadTheDocs.