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

Publish API documentation #2267

Open
ewoutkramer opened this issue Oct 10, 2022 · 0 comments
Open

Publish API documentation #2267

ewoutkramer opened this issue Oct 10, 2022 · 0 comments
Assignees

Comments

@ewoutkramer
Copy link
Member

We have done quite a lot of work on documenting the public interface of the SDK by now. It's by no means complete, but all recent functionality is fully documented, and we work on older bits when we revisit/refactor them.

I think it is time we start publishing the API documentation on our readthedocs website, and to start doing that we need to turn the doc comments in our source code into html.

Gino suggests using docfx. He managed to set it up as a GH workflow with pages (docs.yaml). The generated site is here.

Is this a candidate for us to use?

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

3 participants