This repository contains the source-code of the CATO documentation website http://www.dutchconnectomelab.nl/CATO.
The documentation is in reStructuredText format and uses Sphinx to convert the documentation to an HTML website. Plugins used for the conversion are listed in the requirements file.
| Folder | Description |
|---|---|
| _index | Files for the customized index page that is used instead of the index page generated by Sphinx. |
| _static | Custom static files such as style sheets, JavaScript files and files for the Configuration Assistant. |
| _theme | Files for theme used (an adaption of the sphinxbootstrap4theme). |
| docs | Documentation files and bibliography. |
| images | Images used in the documentation files. |
HTML formatted documentation (as presented on the website) can be generated locally or using GitHub Actions.
Local build: After installing Sphinx and the requirements, HTML documentation can be generated by executing in the CATO-docs directory:
sphinx-build -b html . _build/html
and to replace the index page with the customized index page:
cp ./_index/index.html ./_build/html
cp -r ./_index/assets ./_build/html
GitHub Actions: HTML documentation can also be generated using the workflow "Check and build HTML docs". This workflow is automatically triggered when a pull request is made. This workflow can also be triggered manually using the Run workflow button on the workflow page.
Structural and functional connectivity reconstruction with CATO-A Connectivity Analysis TOolbox
Siemon C. de Lange, Koen Helwegen, and Martijn P. van den Heuvel - NeuroImage, 2023