Skip to content

Commit 9939e84

Browse files
committed
update advanced documentation with local PGM core docs
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
1 parent aefe09e commit 9939e84

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

docs/advanced_documentation/build-guide.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -477,11 +477,16 @@ The `pip install .` part of the command installs the complete package from scrat
477477
478478
The C API documentation is generated using [Doxygen](https://www.doxygen.nl). If you do not have Doxygen installed, it can also be temporarily bypassed by commenting out the `breathe` settings in `docs/conf.py`.
479479
480-
The documentation can be built with the following commands, resulting in html files of the webpages which can be found in `docs/_build/html` directory.
480+
The documentation can be built with the following commands, resulting in HTML files of the webpages which can be found in `docs/_build/html` directory.
481481
482482
```shell
483483
cd docs/doxygen
484484
doxygen
485485
cd ..
486486
sphinx-build -b html . _build/html
487487
```
488+
489+
```{note}
490+
The user documentation generated by [Sphinx](https://github.com/sphinx-doc/sphinx) only contains the C API documentation.
491+
Doxygen, however, also builds the documentation for the Power Grid Model core implementation, which can be accessed after building the documentation locally via `docs/_build/html/index.html`.
492+
```

docs/advanced_documentation/core-design.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,8 @@ graph TD
4848
4949
ComponentsOutput -->|Output| Output(Output data)
5050
```
51+
52+
## Detailed Power Grid Model core design
53+
54+
The sheer size and complexity of the Power Grid Model core implementation makes it hard to generate an up-to-date and comprehensive graph of its design.
55+
For a full overview of the core, it is recommended to build and access the Power Grid Model core documentation by following the steps in the [build guide](./build-guide.md#documentation).

docs/doxygen/Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ EXTRACT_LOCAL_CLASSES = YES
529529
# included.
530530
# The default value is: NO.
531531

532-
EXTRACT_LOCAL_METHODS = NO
532+
EXTRACT_LOCAL_METHODS = YES
533533

534534
# If this flag is set to YES, the members of anonymous namespaces will be
535535
# extracted and appear in the documentation as a namespace called
@@ -868,7 +868,7 @@ WARN_LOGFILE =
868868
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
869869
# Note: If this tag is empty the current directory is searched.
870870

871-
INPUT = ../../power_grid_model_c/
871+
INPUT = "../../power_grid_model_c/" "../../src/" "../../tests/"
872872

873873
# This tag can be used to specify the character encoding of the source files
874874
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

0 commit comments

Comments
 (0)