issues
search
awegroup
/
AWE-Power
A fast cycle-power computation model for fixed-wing ground-generation airborne wind energy systems
MIT License
3
stars
1
forks
source link
Repository review - Software documentation
#4
Open
rishikeshsjoshi
opened
7 months ago
rishikeshsjoshi
commented
7 months ago
Essential
[ ] Installation instructions
[x] User documentation
[ ] Developer documentation
[ ] Source code documentation (
docstrings
)
Recommended
[ ] Examples and tutorials (Jupyter notebooks, videos, screencasts)
[ ] Automate documentation building with
sphinx
[ ] Website (
github.io pages
,
Readthedocs
,
JupyterBook
)
Optional
[ ] Build
API reference
from docstrings
Essential
Recommended
Optional