Write the docs¶
Introduction¶
Write the Docs is a place where the art and science of documentation can be practiced and appreciated.
There are a lot of people out there that write docs, but there isn’t a good place to go to find information, ask questions, and generally be a member of a community of documentarians.
We hope to slowly solve this problem by building a place with high quality information about the art of writing documentation.
Along with that, we hope to open communication between all the awesome people out there writing documentation.
Resources¶
Online documentation: http://docs.writethedocs.org/
Conference: http://conf.writethedocs.org/
Twitter: http://twitter.com/writethedocs
Mailing List: https://groups.google.com/forum/?fromgroups=#!forum/write-the-docs
Issues & feature requests: https://github.com/writethedocs/docs/issues
Source repository: https://github.com/writethedocs/docs
Building these docs¶
This required virtualenv. If you don’t have it installed, first run
pip install virtualenv
.
To build this repo locally, run:
make develop
make documentation
Write the docs Sphinx theme (kr)¶
Write the docs source code¶
See also