KarlNaumann / MacroStat / 14472642576

97%

push

github

Documentation (#7)

* docs: macrostat logo for the docs

* docs: macrostat favicon for the docs

* docs: remove errand print statements

* docs: formatting docstrings for variables.py

* test: Add test to verify the SFC information for different models

* docs: Make doc colors specific to MacroStat logo

* docs: use auto-changelog to generate a changelog. Add in the template file

* docs: switch to using autosummary

* docs: revise documentation homepage using a grid (matplotlib inspo)

* docs: project information section

* docs: development section separated

* docs: user guide starting point

* docs: simplify models library index

* docs: move the logo to the _static directory

* docs: switch to the pyData theme and clean conf.py

* docs: update the docstring of the model class

* docs: separate the parameters and hyperparameters table of the different models

* docs: don't add to git the _autosummary parts

* docs: homepage now has a logo as the left sidebar

* docs: drop the _autosummary generated files

* build: ignore the autogenerated autosummary files

* docs: add the util module to the API reference

* build: fix typo in .gitignore

* docs: add the util module to the API reference index

* feat: export to tex of the equations in behavior class

* docs: placeholder for latex_interfaces, and clearning of GL06SIM notebooks

---------

Co-authored-by: KarlNaumann <karl@naumannwoleske.com>

336 of 396 branches covered (84.85%)

Branch coverage included in aggregate %.

2208 of 2872 relevant lines covered (76.88%)

0.77 hits per line