Statistics
| Branch: | Revision:

iof-tools / networkxMiCe / networkx-master / doc / README.md @ 5cef0f13

History | View | Annotate | Download (804 Bytes)

1
# Building docs
2

    
3
We currently use Sphinx for generating the API and reference
4
documentation for NetworkX.
5

    
6
If you only want to get the documentation, note that pre-built
7
versions can be found at
8

    
9
    http://networkx.github.io/
10

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

    
13
## Instructions
14

    
15
In addition to installing NetworkX and its dependencies, install the Python
16
packages need to build the documentation by entering::
17

    
18
    pip install -r requirements.txt
19

    
20
in the ``doc/`` directory.
21

    
22
To build the HTML documentation, enter::
23

    
24
    make html
25

    
26
in the ``doc/`` directory. If all goes well, this will generate a
27
``build/html`` subdirectory containing the built documentation.
28

    
29
To build the PDF documentation, enter::
30

    
31
    make latexpdf
32

    
33
You will need to have Latex installed for this.