Skip to content

Commit 504ddf0

Browse files
andresailerweb-flow
authored andcommitted
sweep: DIRACGrid#8053 fix doc readme
1 parent 4d98c99 commit 504ddf0

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/README

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,28 @@ 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+
Appropriate means according to the version of DIRAC you want to build the documentation for. See also the [developer
10+
instructions](https://dirac.readthedocs.io/en/latest/DeveloperGuide/DevelopmentEnvironment/DeveloperInstallation/editingCode.html#installing-the-local-version)
11+
12+
13+
1.1 Depending on how you installed DIRAC you might need to install
14+
pip install sphinx_rtd_theme sphinx_design
615

716
2. Go to the Documentation directory of the DIRAC source code repository
817
cd DIRAC/docs/
9-
export PYTHONPATH=$PWD/diracdoctools:$PYTHONPATH
18+
export PYTHONPATH=$PWD:$PYTHONPATH
1019

1120
3. Run the documentation building script
1221

1322
This also creates all the automatically generated rst files
1423

1524
make htmlall
1625

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

1930
make html

0 commit comments

Comments
 (0)