openego / eDisGo / 27217151394
84%
dev: 84%

LAST BUILD BRANCH: 383-custom-plot-colors-Feature
DEFAULT BRANCH: dev
Ran
Jobs 1
Files 55
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 83.622%. Remained the same
27217151394

Pull #646

github

Moritz Schloesser 
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
- Build infra: add nbsphinx/ipython to rtd_requirements.txt and pandoc to
  .readthedocs.yml
Pull Request #646: docs: restructure ReadTheDocs into tiered guide with flexibility chap…

8588 of 10270 relevant lines covered (83.62%)

0.84 hits per line

Jobs
ID Job ID Ran Files Coverage
1 27217151394.1 55
83.62
 GitHub Action Run
Source Files on build 27217151394