-
Notifications
You must be signed in to change notification settings - Fork 3
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
(doc) generate api documentation #6
Comments
I saw readthedocs a few days ago but not the others. I built the docs here but I'm not sure how to get it working. Needs more attention on my part. http://thrusterdesign.readthedocs.io/en/latest/ What do you mean by API generation? |
API generation being code documentation. |
I have still been working from master. I'll make a phildev branch and work On Monday, July 25, 2016, Nate-Wilkins [email protected] wrote:
|
Awesome, I've added a temp sphinx I did run across travis-sphinx and it looks pretty awesome. Documentation is generated by travis-ci then published to That would mean however that we'd be hosting documentation on github pages Not saying that's a bad thing, I actually prefer it, but I don't think we want a wiki and a doc site. Looking into a POC for this on branch Nate-WIlkins/ThrusterDesign#travis-sphinx |
I'm not against gh pages for documentation, at this point I have a preference toward gh pages over the Wiki since it could potentially support math markdown. I agree that we shouldn't have both. |
Look into generating documentation, both from code and markdown docs.
Potentially look into dropping the wiki in favor of readthedocs which integrates nicely with tools like sphinx and mkdocs mkdocs does not have api generation as far as I know.
The text was updated successfully, but these errors were encountered: