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

build docs on readthedocs #32

Closed
aewallin opened this issue Aug 2, 2018 · 3 comments
Closed

build docs on readthedocs #32

aewallin opened this issue Aug 2, 2018 · 3 comments

Comments

@aewallin
Copy link
Owner

aewallin commented Aug 2, 2018

use an automated on-line documentation system like readthedocs.

ideally this should build documentation for both the c++ and python APIs, e.g. based on doxygen for c++ and docstrings for python.

@aewallin
Copy link
Owner Author

aewallin commented Aug 4, 2018

now trying this:
https://breathe.readthedocs.io/en/latest/index.html

we first generate an XML file with doxygen.
breathe is then used to convert the XML to sphinx format.
documentation can then be included in sphinx RST-format documentation (how could this be automated?)

currently the readthedocs build fails because it doesn't import breathe:

ExtensionError: Could not import extension breathe (exception: No module named breathe)

Extension error:
Could not import extension breathe (exception: No module named breathe)

@vespakoen
Copy link
Collaborator

I think this can be closed too =) just need to update the docs now =P

@aewallin
Copy link
Owner Author

thanks! closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants