How to add brian2CUDA documentation

packages used

• sphinx

---

Steps to create documentation

• Step 1: Create a folder to store the documentation (example : docs_sphinx).
• Step 2: Install sphinx package

pip install sphinx

• Step 3: Install the documentation. Usually this is done using sphinx-quickstart, which gives an interactive guide to create the documentation. Recommendation is to run it for the basic structure and then to change it according to brian2 and brians2genn.

---

Description of the contents of the folder

The minimum files/folder structure inside docs_sphinx is

• conf.py
• index.rst

index.rst contains the table of content structure for the documentation.

conf.py contains the configurations for creating the documentation. We will now discuss some custom changes done in conf.py for our documentation.

---

Sphinx extension module for brian2cuda

An additional module to handle documentation extension usage. This module contains function to generate examples, references etc.