Skip to content

Commit

Permalink
docs: document how to contribute to docs; r=sheehan
Browse files Browse the repository at this point in the history
Differential Revision: https://phabricator.services.mozilla.com/D10405

--HG--
extra : moz-landing-system : lando
  • Loading branch information
indygreg committed Oct 31, 2018
1 parent 544e612 commit e55fbbd
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/devguide/docs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. _devguide_docs:

=============================
Contributing to Documentation
=============================

Improvements to the documentation in this repository are very welcome!

Building Documentation Locally
==============================

To build documentation locally, you will need a Python environment.

Assuming you already have a copy of the source repository, run the
following commands to activate the environment for building the docs::

$ ./create-environment docs
$ source venv/docs/bin/activate

Then to build the docs::

$ make -C docs html

You can then open docs/_build/html/index.html in your web browser to
navigate the generated docs.

Submitting Patches
==================

If you have a change to the docs that you would like to be incorporated,
please follow the :ref:`regular contributing guide <devguide_contributing>`
to learn how to submit patches.

Commit messages for documentation-only changes should be prefixed with
``docs:``.
1 change: 1 addition & 0 deletions docs/devguide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ come to the right place!
:maxdepth: 2

contributing
docs
environment
testing
jenkins
Expand Down

0 comments on commit e55fbbd

Please sign in to comment.