52 строки
2.1 KiB
Markdown
52 строки
2.1 KiB
Markdown
[](https://moz-releng-docs.readthedocs.io/en/latest/?badge=latest)
|
|
|
|
# Mozilla Release Engineering Documentation
|
|
|
|
This repository contains some of the more technical internal documentation for Mozilla Release
|
|
Engineering.
|
|
|
|
Rendered versions of the documentation may be viewed at:<br/>
|
|
[http://moz-releng-docs.readthedocs.io/en/latest/](http://moz-releng-docs.readthedocs.io/en/latest/)
|
|
|
|
## Contributing
|
|
|
|
1. Create a Python [virtualenv](https://docs.python.org/3/tutorial/venv.html)
|
|
2. Run:
|
|
|
|
pip install -r requirements/dev.txt
|
|
|
|
3. To build the docs locally and start a [livereload](https://github.com/lepture/python-livereload)
|
|
server, run:
|
|
|
|
make livehtml
|
|
|
|
Verify changes by opening the linked URL in your browser. Further changes will automatically
|
|
rebuild and refresh your page.
|
|
|
|
Alternatively you can run:
|
|
|
|
make html
|
|
|
|
to build static docs. They will be generated under the `_build/html` directory.
|
|
|
|
Note: Any new docs should be directly or indirectly linked to from `index.rst`. (For example, if
|
|
`index.rst` contains `balrog/index.rst` in its
|
|
[toctree](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree),
|
|
and the new doc is in the `balrog/index.rst` toctree, then the new doc is successfully indirectly
|
|
linked.)
|
|
|
|
## Reference
|
|
|
|
These docs use [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText) and
|
|
[Sphinx](https://www.sphinx-doc.org/en/master/index.html). Here are some reference materials:
|
|
|
|
* [reStructuredText primer](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
|
|
* [Sphinx directives](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html)
|
|
* [Sphinx roles](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html)
|
|
* [Sphinx domains](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html)
|
|
|
|
## Motivation
|
|
|
|
For the original motivation behind these docs see [RELENG RFC
|
|
0007](https://github.com/mozilla-releng/releng-rfcs/blob/master/rfcs/0007-docs-location.md).
|