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.

Sign up for GitHub

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

Jump to bottom

Add basic docs #26

Open
jettify opened this issue Mar 2, 2017 · 2 comments
Open

Add basic docs #26

jettify opened this issue Mar 2, 2017 · 2 comments

Comments

@jettify
Copy link
Member

jettify commented Mar 2, 2017

We should have at least one page docs, with basic examples.
@Olegt0rr
Copy link
Collaborator

@jettify, what kind of docs recommened for aio-libs?

@Dreamsorcerer
Copy link
Member

You probably won't get a reply. But, if you want to follow this up, look at the other repositories such as aiohttp-jinja2 and try to setup a similar Sphinx build.

Probably want a usage/tutorial section, which could probably be a more detailed version of the README example. Then an API/reference section which documents the actual functions/methods and their parameters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jettify @Dreamsorcerer @Olegt0rr