search

jessegrabowski / gEconpy

A collection of tools for working with DSGE models in python, inspired by the R package gEcon
https://geconpy.readthedocs.io/en/latest/index.html
GNU General Public License v3.0
23 stars 3 forks source link

Add API docs #37

Closed jessegrabowski closed 4 months ago

jessegrabowski commented 4 months ago

Add autogenerated docs for (almost) all modules. Also update some docstrings to numpy format, and move TODO comments out of docstrings.

📚 Documentation preview 📚: https://gEconpy--37.org.readthedocs.build/en/37/

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 79.73%. Comparing base (33064ee) to head (db5a650). Report is 3 commits behind head on main.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/jessegrabowski/gEconpy/pull/37/graphs/tree.svg?width=650&height=150&src=pr&token=PEY9JOM4ZI&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jesse+Grabowski)](https://app.codecov.io/gh/jessegrabowski/gEconpy/pull/37?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jesse+Grabowski) ```diff @@ Coverage Diff @@ ## main #37 +/- ## ======================================= Coverage 79.73% 79.73% ======================================= Files 37 37 Lines 5126 5126 ======================================= Hits 4087 4087 Misses 1039 1039 ``` | [Files with missing lines](https://app.codecov.io/gh/jessegrabowski/gEconpy/pull/37?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jesse+Grabowski) | Coverage Δ | | |---|---|---| | [gEconpy/parser/parse\_distributions.py](https://app.codecov.io/gh/jessegrabowski/gEconpy/pull/37?src=pr&el=tree&filepath=gEconpy%2Fparser%2Fparse_distributions.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jesse+Grabowski#diff-Z0Vjb25weS9wYXJzZXIvcGFyc2VfZGlzdHJpYnV0aW9ucy5weQ==) | `78.80% <ø> (ø)` | | | [gEconpy/parser/validation.py](https://app.codecov.io/gh/jessegrabowski/gEconpy/pull/37?src=pr&el=tree&filepath=gEconpy%2Fparser%2Fvalidation.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jesse+Grabowski#diff-Z0Vjb25weS9wYXJzZXIvdmFsaWRhdGlvbi5weQ==) | `83.33% <ø> (ø)` | | | [gEconpy/solvers/gensys.py](https://app.codecov.io/gh/jessegrabowski/gEconpy/pull/37?src=pr&el=tree&filepath=gEconpy%2Fsolvers%2Fgensys.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jesse+Grabowski#diff-Z0Vjb25weS9zb2x2ZXJzL2dlbnN5cy5weQ==) | `82.94% <ø> (ø)` | |