Skip to content

Commit

Permalink
revert docs change
Browse files Browse the repository at this point in the history
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
  • Loading branch information
nitbharambe committed Oct 17, 2024
1 parent cad0133 commit 197ab3c
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ build:
jobs:
post_install:
# Build package with doc requirements from pyproject.optional-dependencies
- pip install --verbose --editable .[docs]
- pip install --verbose --editable .[doc]
# remove API DLL define in header
- find power_grid_model_c/power_grid_model_c/include -name *.h -exec sed -i -r "s/#define PGM.*//g" {} \;
- find power_grid_model_c/power_grid_model_c/include -name *.h -exec sed -i -r "s/PGM_API //g" {} \;
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced_documentation/build-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -469,10 +469,10 @@ built and installed, e.g. using `cmake --build --preset <preset> --target instal
## Documentation
The documentation is built in [Sphinx](https://github.com/sphinx-doc/sphinx). It can be built locally in a Python environment. The packages required for building it can be found under the `[docs]` optional dependencies. In addition, the `power-grid-model` Python package needs to be built by following the steps mentioned [above](#build-python-package). After that, the documentation specific packages can be installed via:
The documentation is built in [Sphinx](https://github.com/sphinx-doc/sphinx). It can be built locally in a Python environment. The packages required for building it can be found under the `[doc]` optional dependencies. In addition, the `power-grid-model` Python package needs to be built by following the steps mentioned [above](#build-python-package). After that, the documentation specific packages can be installed via:
```shell
pip install -e .[docs]
pip install -e .[doc]
```
```{note}
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ dynamic = ["version"]

[project.optional-dependencies]
dev = ["msgpack", "pre-commit", "pylint", "pytest", "pytest-cov"]
docs = [
doc = [
"sphinx",
"breathe",
"myst_nb",
Expand Down

0 comments on commit 197ab3c

Please sign in to comment.