FlexMeasures / flexmeasures / 5223097518
78%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 156
Run time 2s
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
5223097518

push

github

web-flow 
docs: Automatic Code Documentation (#698)

* docs: automatic generation of code documentation

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>

* docs: class and module templates

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>

* fix: simplify generated docs

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>

* feat: switch on/off generation of code docs via the parameter gen_code_docs of the makefile command update-docs and update-docs-pdf

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>

* add docstrings for main modules

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* Add docstrings to API modules

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* fix: add autodoc and autosmmary when GEN_CODE_DOCS=True

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>

* fix: set gen_code_docs default to True and False for devs (calling update-docs using make)

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>

* move single test from config package into new tests package

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* fix: show main modules

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>

* fix: remove documentation/_autosummary when gen_code_docs=False

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>

* fix: make generated rst to live under _autosummary/ folder

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>

* add autosummary folder to .gitignore

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* add some spellright words

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* try setting FLASK_ENV during RTD building

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* fix: set a fake SQLALCHEMY_DATABASE_URI

Signed-off-by: Victor Garcia Reolid <victor@seita.nl>

* no need to look for config file when building documentation

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* also export SECRET_KEY in RTD

Signed-off-by: Nicolas Hö... (continued)

1421 of 3358 branches covered (42.32%)

Branch coverage included in aggregate %.

6139 of 9653 relevant lines covered (63.6%)

0.64 hits per line

Jobs
ID Job ID Ran Files Coverage
1 5223097518.1 0
58.1
Source Files on build 5223097518
Detailed source file information is not available for this build.