index.rst

##########################
edx-platform Documentation
##########################

Developer documentation for `edx-platform` can be found in the following
locations.

* The `edx-platform docs directory`_ contains some local developer
  documentation.

* The `Developer Documentation Index`_ in Confluence provides additional links
  to developer documentation for this and other projects. The rest of the `Open
  edX Development space`_ in Confluence provides additional documentation.

* User documentation and a more general Developer's Guide can be read on `Open
  edX ReadTheDocs`_.  The source for these guides can be found in the
  `edx-documentation`_ repository.

.. _edx-platform docs directory: https://github.com/edx/edx-platform/tree/master/docs
.. _Developer Documentation Index: https://openedx.atlassian.net/wiki/display/OpenDev/Developer+Documentation
.. _Open edX Development space: https://openedx.atlassian.net/wiki/spaces/OpenDev/overview
.. _Open edX ReadTheDocs: http://docs.edx.org/

.. toctree::
    :maxdepth: 2

    guides
    docstrings/docstrings


Change History
**************

* April, 2019: API and repository-specific documentation builds resumed.

* May, 2017: The local docs directory was cleared out to start fresh.

* January 13, 2015: The "edX Developer's Guide" was moved to
  `edx-documentation`_.

* November 3, 2014: The documentation for several sub-projects were moved into
  `edx-documentation`_.

.. _edx-documentation: https://github.com/edx/edx-documentation