Skip to content

Adding some much needed seperate docs#56

Closed
seemethere wants to merge 1 commit intodbader:masterfrom
seemethere:master
Closed

Adding some much needed seperate docs#56
seemethere wants to merge 1 commit intodbader:masterfrom
seemethere:master

Conversation

@seemethere
Copy link
Copy Markdown

Responding to this:
#4

It's probably not fully what you want, but hey it's something.

@dbader
Copy link
Copy Markdown
Owner

dbader commented Nov 9, 2015

Thanks for kicking things off here @seemethere! I think we need to set up a way for the API docs to be generated from docstrings in the source. I imagine the docs to be a combination of best practices / usage examples (currently in the FAQ) and the actual API docs.

I really like the Flask docs to give an example: http://flask.pocoo.org/docs/0.10/

@dbader
Copy link
Copy Markdown
Owner

dbader commented Nov 7, 2016

Linking this to #4 – we can possible reuse some of the copy there.

Thank you – I'm closing this so we can keep the tracker clean of loose ends. Feel free to follow up (or make a separate issue) with more questions/discussion 😃

@dbader dbader closed this Nov 7, 2016
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

Successfully merging this pull request may close these issues.

2 participants