File: README.md

package info (click to toggle)
qcengine 0.30.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,524 kB
  • sloc: python: 36,452; makefile: 54; sh: 35
file content (15 lines) | stat: -rw-r--r-- 528 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Compiling QCEngine's Documentation

The docs for this project are built with Sphinx. To compile the docs, first ensure that Sphinx and the ReadTheDocs theme are installed.

```
conda install sphinx sphinx_rtd_theme 
```

Once installed, you can use the Makefile in this directory to compile static HTML pages by

```
make html
```

The compiled docs will be in the _build directory and can be viewed by opening index.html (which may itself be inside a directory called html/ depending on what version of Sphinx is installed).