openego / eDisGo / 27402081746
84%
dev: 84%

LAST BUILD BRANCH: docs/restructure-readthedocs
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
27402081746

Pull #646

github

joda9 
docs: render the Julia OPF (eDisGo_OPF) API natively on Read the Docs

Sphinx cannot autodoc Julia, and Documenter.jl only builds a separate
standalone HTML site. To show the Julia OPF API as a normal page inside
the Python documentation — same theme, same left-hand TOC, same search —
add a small Sphinx extension that parses the Julia source for docstrings
(no Julia runtime, no Gurobi) and writes a MyST-Markdown page that Sphinx
renders like any other page.

- Add doc/_ext/julia_autodoc.py: on builder-inited it scans
  edisgo/opf/eDisGo_OPF.jl/src for documented definitions and generates
  doc/reference/julia_api.md, regenerated on every build so it grows as
  docstrings are added. It mirrors Julia's own attach rule (skips empty
  "" placeholders and strings separated from the definition by a blank
  line) and falls back to a stub if the Julia sources are absent.
- Wire it in: add myst_parser + julia_autodoc to conf.py (with dollarmath
  and colon_fence), add myst-parser to rtd_requirements.txt, add the
  reference/julia_api entry to the Reference toctree, and gitignore the
  generated page.
- Add docstrings throughout the eDisGo_OPF Julia module so the reference
  is useful: the three problem-formulation structs (base / SOC / NC), the
  problem build and solve entry points, the variable, constraint and
  objective functions (mapped to their OPF formulation equations and
  opf_version variants), and the I/O and solution helpers. The page now
  lists 81 documented symbols. Also add a module-level docstring and
  document the Main.jl driver script (source/REPL only; not part of the
  generated API page).
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 27402081746.1 55
83.62
 GitHub Action Run
Source Files on build 27402081746