Quickstart¶

Usage

Development

Release

pysphinxdoc¶

Pysphinxdoc is a tool for generating automatically API documentation for Python modules, based on their reStructuredText docstrings, using Sphinx.

Important links¶

Official source code repo: https://github.com/brainprepdesk/pysphinxdoc
HTML documentation (stable release): https://brainprepdesk.github.io/pysphinxdoc/stable
HTML documentation (dev): https://brainprepdesk.github.io/pysphinxdoc/dev

Install¶

Latest release¶

1. Setup a virtual environment

We recommend that you install pysphinxdoc in a virtual Python environment, either managed with the standard library venv or with conda. Either way, create and activate a new python environment.

With venv:

python3 -m venv /<path_to_new_env>
source /<path_to_new_env>/bin/activate

Windows users should change the last line to \<path_to_new_env>\Scripts\activate.bat in order to activate their virtual environment.

With conda:

conda create -n pysphinxdoc python=3.12
conda activate pysphinxdoc

2. Install pysphinxdoc with pip

Execute the following command in the command prompt / terminal in the proper python environment:

python3 -m pip install -U pysphinxdoc

Check installation¶

Try importing pysphinxdoc in a python / iPython session:

import pysphinxdoc

If no error is raised, you have installed pysphinxdoc correctly.

Dependencies¶

The required dependencies to use the software are listed in the file pyproject.toml.