blob: 89eb976556ebafc6b743967c54b2b8ccbf61f1da (
plain) (
blame)
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
|
# Overview
This explains how to generate the documentation for Warpx, and contribute to it.
## Generating the documentation
### Installing the requirements
Install the Python requirements for compiling the documentation:
```
pip install sphinx sphinx_rtd_theme
```
### Compiling the documentation
`cd` into this directory and type
```
make html
```
You can then open the file `build/html/index.html` with a standard web browser (e.g. Firefox), in order to visualize the results on your local computer.
### Cleaning the documentation
In order to remove all of the generated files, use:
```
make clean
```
### Regenerating the theory documentation
The theory is generated from Latex sources in PICSAR, and the resulting `.rst`
files are stored in the current repo, in `source/latex_theory`. In order to
regenerate the theory documentation:
```
make Latex-conversion
```
|
