Skip to content

Commit fd54c6f

Browse files
committed
fix(docs): Update instructions for building documentation
1 parent 9af4389 commit fd54c6f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/README

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,24 @@ How to build DIRAC documentation
33

44
1. Create DIRAC client environment by an appropriate
55
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
611

712
2. Go to the Documentation directory of the DIRAC source code repository
813
cd DIRAC/docs/
9-
export PYTHONPATH=$PWD/diracdoctools:$PYTHONPATH
14+
export PYTHONPATH=$PWD:$PYTHONPATH
1015

1116
3. Run the documentation building script
1217

1318
This also creates all the automatically generated rst files
1419

1520
make htmlall
1621

22+
Note: You must avoid having the string "test" in your folder structure or no code documentation will be created.
23+
1724
3.1 to run incremental builds after rst files have changed, only run
1825

1926
make html

0 commit comments

Comments
 (0)