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

[CT-1369] Human-written docs for top level API via Sphinx #6099

Closed
Tracked by #6706
iknox-fa opened this issue Oct 18, 2022 · 1 comment
Closed
Tracked by #6706

[CT-1369] Human-written docs for top level API via Sphinx #6099

iknox-fa opened this issue Oct 18, 2022 · 1 comment
Labels

Comments

@iknox-fa
Copy link
Contributor

iknox-fa commented Oct 18, 2022

In #5528 we added automatic documentation for the top level API. This ticket encompasses the work to expand that with a human-written section with examples/how to sections as needed to flesh out the documentation for said API.

AC: The documentation is fully ready for internal consumption but this doesn't cover styling beyond the basic markup needed for readability.

@github-actions github-actions bot changed the title Human-written docs for top level API via Sphinx [CT-1369] Human-written docs for top level API via Sphinx Oct 18, 2022
@iknox-fa
Copy link
Contributor Author

Updated from BLG: This work is intended to be stand alone from the extension created in #5528. Implement as block at top of automated docs in order to KISS.

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

No branches or pull requests

2 participants