Enhance and finalize documentation

pledge4future / co2calculator

Python package to calculate work related CO2 emissions from heating and electricity consumption as well as business trips and commuting.

https://pledge4future.github.io/co2calculator/

GNU General Public License v3.0

13 stars 7 forks source link

Enhance and finalize documentation #160

Open codingfabi opened 6 months ago

codingfabi commented 6 months ago

Tasks necessary to bring the documentation to a proper state for v1.0.0:

[ ] Include docstrings as function documentation
[ ] Upgrade color coding to match p4f corporate design
[ ] Include jupyter notebooks with use case examples (see #158)
[ ] Include methodology text blocks into documentation
[ ] Include details on parameter values, e.g., what does size="large" mean for a car?

armandyam commented 4 months ago

Is the documentation available here updated? I am trying to use the business trip for calculating my flight emissions but I cant find the implementation at all.

sarahmadeleine commented 4 months ago

@codingfabi