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.

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

Removing documentation index page #771

Merged
merged 16 commits into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Consider scaling factor with flex options [#734](https://github.com/ie3-institute/simona/issues/734)
- Implementation of Energy Management Agents [#204](https://github.com/ie3-institute/simona/issues/204)
- Providing documentation for EmAgent protocols and algorithms [#774](https://github.com/ie3-institute/simona/issues/774)
- New documentation index page [#375](https://github.com/ie3-institute/simona/issues/375)

### Changed
- Adapted to changed data source in PSDM [#435](https://github.com/ie3-institute/simona/issues/435)
Expand Down
17 changes: 17 additions & 0 deletions docs/readthedocs/allpages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
(allpages)=

# All Pages

Here are all available pages listed:

```{toctree}
---
maxdepth: 1
---
.. toctree::
:maxdepth: 2
:glob:

*
!allpages
```
1 change: 0 additions & 1 deletion docs/readthedocs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
# PlantUML options
plantuml = 'plantuml'


# Intersphinx for references to external ReadTheDocs
intersphinx_mapping = {
'psdm': ('https://powersystemdatamodel.readthedocs.io/en/latest/', None),
Expand Down
7 changes: 4 additions & 3 deletions docs/readthedocs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@ Institute of Energy Systems, Energy Efficiency and Energy Economics at TU Dortmu
models
developersguide
references
allpages

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
For more information, please visit the :doc:`All Pages <allpages>` page.