openego / eDisGo / 28024210650

84%

Build Type

push

github

Committed by web-flow

Commit Message

docs: restructure ReadTheDocs into tiered guide with flexibility chap… (#646)

* docs: restructure ReadTheDocs into tiered guide with flexibility chapters

Reorganise the documentation by depth (Getting Started → User Guide →
Methodology & Physics → Reference) so it is usable for all user levels, and
rebuild the flexibility & optimisation documentation from the ground up.

- New grouped toctree in index.rst; split usage_details into a task-oriented
  User Guide (data sources, workflow, data model, time series, components,
  analysis & results) and retire features_in_detail.rst
- Add Methodology pages (power flow, grid reinforcement, complexity reduction)
  that explain each function and its physics, cross-linked to the AutoAPI ref
- Add methodology/flexibility/* : overview, multi-period OPF (pm_optimize,
  SOC/NC, opf_version 1-4), electromobility, heat pumps, DSM, storage,
  reactive power and overlying grid
- Render the hands-on walkthrough and example notebooks via nbsphinx
  (nbsphinx_execute=never); switch math to MathJax; set language to "en"
- Add an installation page and a slim contributing guide; move legacy/
  unmaintained methods (non-linear OPF, curtailment, storage heuristic) to a
  clearly marked "Experimental & Legacy" section
- Fix outdated API cross-references (e.g. mv_line_overload ->
  mv_line_max_relative_overload), stale labels (features-in-detail) in
  reinforce_grid.py and edisgo.py, the grid.components namespace, and a
  copy-paste error in the DSM.p_max docstring
- Include the orphaned whatsnew/v0-3-0 entry and describe the doc restructuring
  in it
- Build infra: add nbsphinx/ipython to rtd_requirements.txt and pandoc to
  .readthedocs.yml

Tutorial notebooks:
- Translate full_workflow_walkthrough.ipynb fully to English (markdown, prose
  and code comments)
- Make full_workflow_walkthrough.ipynb portable: download the egon-format
  example grid (ding0_test_network_3) into $EDISGO_DATA_DIR (default ~/.edisgo)
  instead of hard... (continued)

Coverage Stats

4 of 4 new or added lines in 2 files covered. (100.0%)

1 existing line in 1 file now uncovered.

8588 of 10270 relevant lines covered (83.62%)

0.84 hits per line