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

Create automatic documentation generation #2

Open
GPMueller opened this issue Jun 25, 2018 · 1 comment
Open

Create automatic documentation generation #2

GPMueller opened this issue Jun 25, 2018 · 1 comment
Labels
documentation enhancement New feature or request

Comments

@GPMueller
Copy link
Member

Probably readthedocs.io would do nicely.

However, it should be looked into if some of the API docs can be automatically generated from the source code, in order to avoid them going out of date.

@GPMueller
Copy link
Member Author

The C API could be nicely documented using https://github.com/GPMueller/clang-api-doc
This would produce docs similar to https://spirit-docs.readthedocs.io/en/latest/core/docs/c-api/API_Reference.html

The Python interface can be automatically documented, but it is ugly to do with readthedocs because we would need to build the whole ovf library. I am against doing this on this project.

@GPMueller GPMueller added documentation enhancement New feature or request labels Aug 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant