summaryrefslogtreecommitdiff
path: root/doc/README.md
blob: 96012b252e53e9efa77b999929c1a8e98264e0d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Building docs

We use Sphinx for generating the API and reference documentation.

Pre-built versions can be found at

    https://networkx.org/

for both the stable and the latest (i.e., development) releases.

## Instructions

After installing NetworkX and its dependencies, install the Python
packages needed to build the documentation by entering::

    pip install -r requirements/doc.txt

in the root directory.

To build the HTML documentation, enter::

    make html

in the `doc/` directory. This will generate a `build/html` subdirectory
containing the built documentation.

To build the PDF documentation, enter::

    make latexpdf

You will need to have LaTeX installed for this.