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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# Documenting nbconvert
[Documentation for `nbconvert`](https://nbconvert.readthedocs.io/en/latest/)
is hosted on ReadTheDocs.
## Build Documentation locally
1. Change directory to documentation root:
```
$ cd docs
```
1. Create conda env (and install relevant dependencies):
```
$ conda env create -f environment.yml
```
1. Activate the newly built conda environment `nbconvert_docs`
```
$ source activate nbconvert_docs
```
1. Create an editable install for nbconvert with doc dependencies using
```
$ pip install -e '..[docs]'
```
or if you want, `cd ..` and `pip install . -e`. But then you will need to `cd docs` before
continuing to the next step.
1. Build documentation using Makefile for Linux and OS X:
```
$ make html
```
or on Windows:
```
$ make.bat html
```
1. Display the documentation locally by navigating to
`build/html/index.html` in your browser:
Or alternatively you may run a local server to display
the docs. In Python 3:
```
$ python -m http.server 8000
```
In your browser, go to `http://localhost:8000`.
## Developing Documentation
### Helpful files and directories
- `conf.py` - Sphinx build configuration file
- `source` directory - source for documentation
- `source/api` directory - source files for generated API documentation
- `autogen_config.py` - Generates configuration of ipynb source files to rst
- `index.rst` - Main landing page of the Sphinx documentation
|
