Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sphinx #3

Merged
merged 10 commits into from
May 2, 2020
Merged

Sphinx #3

merged 10 commits into from
May 2, 2020

Conversation

Czarified
Copy link
Owner

Project converted to a full python package, and documentation created.

Fixed heli.hover bsfc, and some mission sim bsfc fuel calc.

Renamed the "burn" loop variables to "fuel" to be more logically semantic.

created initial module files. This branch will convert the single notebook into a module with sphinx documentation.
added a loiter conditional

tweaked the mission radius to give at least 30lbs of fuel in reserve (~10min loiter).
Notebook file converted to a module and main script.
Docs set up, autodoc not working. Need to prepare for packaging before continuing with autodoc.
autodoc work for Helicopter class documentation. Hopefully incorporated with readthedocs?
Commented the sphinx theme so hopefully readthedocs version will look nice.
Locally installed the ReadTheDocs theme.
added autofunctions to the api page.
Broke out further packaging, pushed to PyPI, and added some docs pages. Also expanded the readme to match the basic doc intro page.
fixed the autodoc api page after the re-packaging.
@Czarified Czarified merged commit 228b835 into master May 2, 2020
@Czarified Czarified deleted the sphinx branch May 2, 2020 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant