search

runphilrun / TDU

Thruster design utility for satellite propulsion
https://stemn.com/projects/thruster-design-tool
Apache License 2.0
9 stars 3 forks source link

(doc) generate api documentation #6

Open Nate-Wilkins opened 8 years ago

Nate-Wilkins commented 8 years ago

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.

runphilrun commented 8 years ago

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?

Nate-Wilkins commented 8 years ago

API generation being code documentation. You working in a separate branch for this?

runphilrun commented 8 years ago

I have still been working from master. I'll make a phildev branch and work on that for now to avoid conflicts.

On Monday, July 25, 2016, Nate-Wilkins notifications@github.com wrote:

API generation being code documentation. You working in a separate branch for this?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/runphilrun/ThrusterDesign/issues/6#issuecomment-235123878, or mute the thread https://github.com/notifications/unsubscribe-auth/AF6lpXMFjVHOFLZDIUPxcRTrDg0XXitZks5qZU9sgaJpZM4JTvSr .

Nate-Wilkins commented 8 years ago

Awesome, I've added a temp sphinx conf.py to the docs folder but I think you'll know what's best regarding LaTeX and other documentation settings.

I did run across travis-sphinx and it looks pretty awesome. Documentation is generated by travis-ci then published to gh-pages

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

runphilrun commented 8 years ago

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.