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

Incorporate source code documentation into read the docs #4

Open
patbat opened this issue Sep 24, 2019 · 4 comments
Open

Incorporate source code documentation into read the docs #4

patbat opened this issue Sep 24, 2019 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@patbat
Copy link
Owner

patbat commented Sep 24, 2019

The source code is documented ether via doxygen-like comments (this holds true for the c++ code) or via python docstrings. It might (!) be a good idea to include this documentation in an automatic fashion in the readthedocs documentation.

@patbat patbat added the documentation Improvements or additions to documentation label Oct 11, 2019
@patbat
Copy link
Owner Author

patbat commented Feb 5, 2020

At least for the docstrings it is indeed a good idea.

@patbat
Copy link
Owner Author

patbat commented Feb 7, 2020

Use sphyinx autodoc.

@patbat
Copy link
Owner Author

patbat commented Feb 10, 2020

Even better: sphinx-apidoc.

@patbat
Copy link
Owner Author

patbat commented Feb 12, 2020

While the offline build works fine, integration with readthedocs does not. That is, there is no documentation generated from the docstrings online accessible. One idea to get this going is to tell readthedocs to build khuri. However, this is not straightforward, for the building process requires cmake and external libraries.

Is there an easy way to have the api documenation online?

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

No branches or pull requests

1 participant