elabdoc

Description

Source files for the elabftw documentation.

Main project repository: elabftw/elabftw.

Installation

git clone https://github.com/elabftw/elabdoc
cd elabdoc
pip install --user sphinx sphinx_rtd_theme sphinxcontrib-jquery

Config examples

You might want to look into the config_examples folder for Apache, HAProxy, Nginx or Traefik configuration as reverse proxy.

Usage

To generate the HTML documentation:

cd doc
make html

Then point your browser to the _build/html/index.html file inside the doc/ folder.

CI

The generated documentation can also be accessed in the Artifacts section of the CircleCI builds.

Click on "pdf" to get the doc as a pdf.

Headings used

***********
MAIN HEADER
***********

TITLE
=====

SUBTITLE
--------

SUBSUBTITLE
^^^^^^^^^^^

SUBSUBSUBTITLE
""""""""""""""