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

Documentation #7

Open
maxpeterson opened this issue Feb 19, 2014 · 2 comments
Open

Documentation #7

maxpeterson opened this issue Feb 19, 2014 · 2 comments

Comments

@maxpeterson
Copy link
Member

How do we document this library. Potentially this will develope into a lot of unrelated utilities so it would be good to work out how we make sure people can find out what is available.

The documentation within the code is pretty good so could we just generate docs.
@maxpeterson
Copy link
Member Author

Any ideas @meshy @Ian-Foote

@LilyFoote
Copy link
Collaborator

Probably using sphinx would be most appropriate.

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
2 participants
@maxpeterson @LilyFoote