Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[sweep:integration] fix doc readme #8054

Merged
merged 1 commit into from
Feb 20, 2025
Merged

[sweep:integration] fix doc readme #8054

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,28 @@ How to build DIRAC documentation

1. Create DIRAC client environment by an appropriate
source bashrc
or
source diracos/diracosrc

Appropriate means according to the version of DIRAC you want to build the documentation for. See also the [developer
instructions](https://dirac.readthedocs.io/en/latest/DeveloperGuide/DevelopmentEnvironment/DeveloperInstallation/editingCode.html#installing-the-local-version)


1.1 Depending on how you installed DIRAC you might need to install
pip install sphinx_rtd_theme sphinx_design

2. Go to the Documentation directory of the DIRAC source code repository
cd DIRAC/docs/
export PYTHONPATH=$PWD/diracdoctools:$PYTHONPATH
export PYTHONPATH=$PWD:$PYTHONPATH

3. Run the documentation building script

This also creates all the automatically generated rst files

make htmlall

Note: You must avoid having the string "test" in your folder structure or no code documentation will be created.

3.1 to run incremental builds after rst files have changed, only run

make html
Expand Down
Loading