mdolab / openconcept

OpenConcept: A toolkit for conceptual MDAO of aircraft with unconventional propulsion architectures
MIT License
36 stars 32 forks source link

Enable automatic documentation #7

Closed bbrelje closed 6 years ago

bbrelje commented 6 years ago

Reconfiguration of the project for autodocs. Many docstrings updated (but not all by any means). Changed : delimiter to | to avoid problems in numpydocstrings. fixes #1

coveralls commented 6 years ago

Pull Request Test Coverage Report for Build 48


Changes Missing Coverage Covered Lines Changed/Added Lines %
openconcept/utilities/math/sum_old.py 0 1 0.0%
openconcept/analysis/atmospherics/true_airspeed.py 6 7 85.71%
openconcept/components/empirical_data/prop_maps.py 0 2 0.0%
openconcept/analysis/atmospherics/dynamic_pressure_comp.py 6 8 75.0%
openconcept/components/gearbox.py 0 3 0.0%
openconcept/utilities/linearinterp.py 1 6 16.67%
openconcept/analysis/atmospherics/compute_atmos_props.py 15 28 53.57%
openconcept/components/propeller.py 0 25 0.0%
openconcept/analysis/aerodynamics.py 6 46 13.04%
openconcept/analysis/takeoff.py 12 148 8.11%
<!-- Total: 65 565 11.5% -->
Files with Coverage Reduction New Missed Lines %
openconcept/components/propeller.py 1 13.14%
openconcept/analysis/takeoff.py 3 12.61%
openconcept/analysis/mission.py 13 15.76%
<!-- Total: 17 -->
Totals Coverage Status
Change from base Build 34: 8.4%
Covered Lines: 1076
Relevant Lines: 2481

💛 - Coveralls
bbrelje commented 6 years ago

This package enables documentation on readthedocs.io. The content of the documentation itself is still a work of progress; however, it's worth merging in the changes at this point since they are sizable in and of themselves.