adonmo / meos

Mobility Engine, Open Source
https://adonmo.github.io/meos/
MIT License
21 stars 3 forks source link

Publish documentation (Python and C++) #5

Closed chaitan94 closed 4 years ago

chaitan94 commented 4 years ago

This issue is regarding just setting up the basic boilerplate code for docs. Actual content could come later and would of course be constantly improving.

But at a high level, the doc structure could contain:

Quick link for docs of sphinx

Python + autodoc

https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

C++

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cpp-domain https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

chaitan94 commented 4 years ago

MEOS (C++) docs

Now available on Github Pages: https://adonmo.github.io/meos/ Automated deploys via Github actions/: bf09428a0b98f9ad05e83c45affc45cd84a3bc9e Built with doxygen, with m.css Updated urls in 2a0a33f44f888d5548e245c4c5d4f7bec160910d

PyMEOS (Python) docs

Now available on readthedocs: https://pymeos.readthedocs.io/en/latest/ Related commit for setup 6590d82fe7442d19f1990ff2433dc540c1920fad Built with sphinx in readthedocs theme Automated deploys via webhooks on every push Update URLS, logo and favicon in 713109ee4b105c67f7c1da65adfd4e85c6490d54