addons-server/docs
Lisa Chan 4e5dc5cdcb
RE: Add addon_type property to shelf module, remove search-themes shelf endpoint type (#16967)
* Remove search-themes endpoint choice, added addon_type field

* Updated test_admin.py

* Updated doc, models, forms (and test), test_serializers, test_admin, migration file

* Fixed lint issues

* Updated serializer to reflect addon_type choice name instead of integer

* Fixed lint issues

* Updated addon_type from int in test_admin
2021-04-21 17:30:41 +01:00
..
_intersphinx django_nose cleanup: we're using py.test 2014-12-22 15:52:49 +01:00
_static use .gitkeep instead of .gitignore; bug 687408 2013-09-19 07:56:17 -07:00
_templates use .gitkeep instead of .gitignore; bug 687408 2013-09-19 07:56:17 -07:00
extensions Remove all usage of 'six' and as much compat code as I could f… (#11730) 2019-07-16 12:01:31 +02:00
screenshots Update docker Makefile commands and docs 2015-10-22 12:53:16 -05:00
settings Fixes #5379: Remove footer field from theme submission form (#7718) 2018-03-21 15:01:39 +01:00
topics RE: Add addon_type property to shelf module, remove search-themes shelf endpoint type (#16967) 2021-04-21 17:30:41 +01:00
Makefile Build docs on make loop 2015-09-17 14:30:32 +01:00
README.rst Update requirements/docs.txt, install it explicitly to be self-containing. (#2891) 2016-06-14 17:20:55 +02:00
__init__.py Split off API docs (bug 854942) 2013-04-15 13:54:46 -05:00
build-github.zsh rm everything in gh-pages so old pages aren't left around + typo & pushd 2010-02-02 21:55:50 -08:00
conf.py Update Browse and Compare API endpoints to allow for `file_only` (#14163) 2020-05-06 08:25:13 -04:00
index.rst change api docs to make v5 the default (#16303) 2021-01-12 16:20:18 +00:00
watcher.py script to watch a bunch of files and run a command if any changes are detected. 2009-11-06 22:32:35 -08:00

README.rst

============================
Add-ons Server Documentation
============================

This is the documentation for the use of the addons-server and its services.
All documentation is in plain text files using
`reStructuredText <http://docutils.sourceforge.net/rst.html>`_ and
`Sphinx <http://sphinx-doc.org/>`_.

To build the documentation, you need the dependencies from
``requirements/docs.txt``.  Those are automatically installed together with
``make update_deps``, so if you've installed that already (following the
:ref:`installation` page), you're all set.

If you're unsure, activate your ``virtualenv`` and run::

    make update_deps

The documentation is viewable at http://addons-server.readthedocs.io/, and
covers development using Add-ons Server, the source code for `Add-ons
<https://addons.mozilla.org/>`_.

Its source location is in the `/docs
<https://github.com/mozilla/addons-server/tree/master/docs>`_ folder.

Note: this project was once called *olympia*, this documentation often uses
that term.

Build the documentation
-----------------------

This is as simple as running::

    make docs

This is the same as ``cd``'ing to the ``docs`` folder, and running ``make
html`` from there.

We include a daemon that can watch and regenerate the built HTML when
documentation source files change. To use it, go to the ``docs`` folder
and run::

    python watcher.py 'make html' $(find . -name '*.rst')

Once done, check the result by opening the following file in your browser:

    /path/to/olympia/docs/_build/html/index.html