scilus / scil-documentation

Documentation for the SCIL
4 stars 15 forks source link

Documentation Status

scil-documentation

The reference website of the Sherbrooke Connectivity Imaging Laboratory (SCIL) is available here.

[!NOTE] scil-documentation describes useful tools and resources for working at the SCIL.

Contributing

Contributions to the website are welcome. The website is tested for python3. To install locally, first clone the repo. Then, install sphinx and sphinx-rtd-theme with:

pip install sphinx sphinx-rtd-theme

And build the website locally with:

make html

The built documentation is available under ./build/html/. To explore your local version of the documentation, open ./build/html/index.html in your favorite web browser.