-
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation build instructions and custom script details
Added a README with instructions on building documentation locally, including installing dependencies and running build commands. Custom scripts generate additional documentation files.
- Loading branch information
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# How to build the documentation locally | ||
|
||
To build the documentation locally, you need to install the required dependencies and run the build command. | ||
|
||
## Install dependencies | ||
|
||
To install the required dependencies, run the following command: | ||
|
||
```bash | ||
pip install -r docs/requirements.txt | ||
``` | ||
|
||
## Build the documentation | ||
|
||
To build the documentation, run the following command: | ||
|
||
```bash | ||
make -C docs html | ||
``` | ||
|
||
There are other documentation files that are generated using some custom scripts. To generate these files, run the following commands: | ||
|
||
You will need to have Doxygen installed to generate the Doxygen documentation. | ||
|
||
```bash | ||
# Generate Doxygen documentation | ||
doxygen docs/Doxyfile | ||
|
||
# Generate Sphinx documentation from Doxygen | ||
python .scripts/link_doxygen_sphinx.py | ||
|
||
# Link Examples | ||
python .scripts/link_examples_sphinx.py | ||
|
||
# Run changelog updater | ||
run: python .scripts/update_changelog.py | ||
|
||
# Append includes to index files | ||
python .scripts/append_includes.py docs/source/reference/migration desc false | ||
``` | ||
|
||
The generated HTML files will be available in the `docs/build/html` directory. |