dependabot[bot] f617ba6f06 Bump urllib3 from 1.22 to 1.26.5 in /docs/pyMCell		3 年之前
..
Makefile	006ff3d74b Use Sphinx Autodoc for pyMCell.	6 年之前
README.md	543b0a8612 Clean up pyMCell documentation.	6 年之前
conf.py	543b0a8612 Clean up pyMCell documentation.	6 年之前
data_model_import.rst	543b0a8612 Clean up pyMCell documentation.	6 年之前
index.rst	543b0a8612 Clean up pyMCell documentation.	6 年之前
pymcell_helpers.rst	543b0a8612 Clean up pyMCell documentation.	6 年之前
requirements.txt	f617ba6f06 Bump urllib3 from 1.22 to 1.26.5 in /docs/pyMCell	3 年之前

pyMCell Sphinx Autodoc

The documentation for pyMCell is automatically generated based off of the docstrings using Sphinx.

To build the HTML, you'll want to activate a python virtual environment:

python3 -m venv sphinx_env
source sphinx_env/bin/activate

Then install the requirements:

pip3 install -r requirements.txt

Run make:

make html

View docs:

firefox _build/html/index.html

Obviously, you can use a different browser if you want.