Skip to content

Building documentation locally

This site is built with MkDocs + Material.

The docs include:

  • markdown pages (concepts + reference),
  • notebook tutorials (rendered via mkdocs-jupyter),
  • API pages generated from docstrings (mkdocstrings).

1) Create an environment

cTopo depends on RDKit, so Conda is recommended.

conda create -n ctopo-docs python=3.10 -y
conda activate ctopo-docs
conda install -c conda-forge rdkit networkx -y

2) Install cTopo (editable) + docs tooling

From the repository root:

pip install -e .
pip install -r requirements-docs.txt

mkdocs serve

Then open the local URL printed in the terminal.

4) Build static site

mkdocs build

The rendered site will appear in site/.

Tip

Notebook pages are rendered via mkdocs-jupyter.

By default we set execute: false, so notebooks are not executed during the build. If you want output to appear in the docs, run the notebook once and commit it with outputs.

5) Adding pages

  • Add a markdown page under docs/...
  • Then register it in mkdocs.yml under nav:

MkDocs builds navigation strictly from mkdocs.yml, so new pages won’t appear until they are listed there.