.. index::
   pair: Sphinx; Write the docs

.. _write_the_docs:

==========================
Write the docs
==========================

.. seealso::

   - http://docs.writethedocs.org/
   - https://twitter.com/writethedocs


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/
- IRC: `#writethedocs on freenode <http://webchat.freenode.net/?channels=writethedocs>`_
- 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_theme:

Write the docs Sphinx theme (kr)
================================

.. seealso::

   - https://github.com/writethedocs/docs/blob/master/docs/conf.py
   - http://docs.writethedocs.org/en/2013/
   - :ref:`kr_theme`




Write the docs source code
==========================

.. seealso::

   - https://github.com/writethedocs/docs