membrane-curvature

Compiling Membrane Curvature’s Documentation

The docs for this project are built with Sphinx using the mdanalysis-sphinx-theme. To compile the docs, first ensure that:

1. All necessary dependencies are installed.
2. You are working in the /docs directory.

Installing dependencies

Via conda

To install a new environment with conda to compile the documentation, run:

conda install sphinx mdanalysis-sphinx-theme 

Via pip

Alternatively, to install all doc dependencies in your environment, run:

pip install -r requirements.txt

Compiling MembraneCurvature Sphinx docs

Once all dependencies are installed, you can use the Makefile in this directory to compile static HTML pages with

make html

The compiled docs will be in the _build directory and can be viewed by opening index.html.

This site is open source. Improve this page.