File tree Expand file tree Collapse file tree 1 file changed +8
-1
lines changed Expand file tree Collapse file tree 1 file changed +8
-1
lines changed Original file line number Diff line number Diff line change @@ -3,17 +3,24 @@ How to build DIRAC documentation
3
3
4
4
1. Create DIRAC client environment by an appropriate
5
5
source bashrc
6
+ or
7
+ source diracos/diracosrc
8
+
9
+ 1.1 Depending on how you installed DIRAC you might need to install
10
+ pip install sphinx_rtd_theme sphinx_design
6
11
7
12
2. Go to the Documentation directory of the DIRAC source code repository
8
13
cd DIRAC/docs/
9
- export PYTHONPATH=$PWD/diracdoctools :$PYTHONPATH
14
+ export PYTHONPATH=$PWD:$PYTHONPATH
10
15
11
16
3. Run the documentation building script
12
17
13
18
This also creates all the automatically generated rst files
14
19
15
20
make htmlall
16
21
22
+ Note: You must avoid having the string "test" in your folder structure or no code documentation will be created.
23
+
17
24
3.1 to run incremental builds after rst files have changed, only run
18
25
19
26
make html
You can’t perform that action at this time.
0 commit comments