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

Sphinx documentation missing for public APIs #2

Open
manneohrstrom opened this issue Feb 21, 2019 · 3 comments
Open

Sphinx documentation missing for public APIs #2

manneohrstrom opened this issue Feb 21, 2019 · 3 comments
Assignees
Milestone

Comments

@manneohrstrom
Copy link
Contributor

Add sphinx documentation to cover all public methods that form the official contract of the API and how it is intended to be used. For an example, see https://github.com/shotgunsoftware/tk-framework-shotgunutils.

@manneohrstrom
Copy link
Contributor Author

Meeting notes:

@manneohrstrom
Copy link
Contributor Author

@martinminsel i ended up doing a much more etxensive CR of the framework and i found a bunch of stuff we need to adjust. Nothing major, but important to get right ASAP. I created a bunch of v0.2 tickets.

For the docs themselves, i think we are close - see my latest PR comments - hopefully if you do a quick pass over the interfaces we can get a first iteration of the docs in place. Then we tackle the bigger items that are logged in tickets separately.

Back to you!

Thanks!

@manneohrstrom
Copy link
Contributor Author

This didn't make it into the first release, so marking as v0.2.

@manneohrstrom manneohrstrom modified the milestones: v0.1, v0.2 Mar 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants