.. Specifications of Byteflies house style
.. Author: Charlotte Palmers

.. STATUS: draft

.. role:: red

.. note:: This is a DRAFT

###########################
Document Template (Level 1)
###########################

One paragraph description of the purpose of the document.

For assistance with syntax, refer to the :ref:`reStructuredText tutorial <reST_tutorial>`.

.. rubric:: Quick Navigation
.. contents::
   :local:
   :depth: 2

.. _example-anchor:

----

***************
Level 2 Heading
***************

There is no one-size-fits-all template. If possible, fork an existing document with a similar structure to maintain consistency. Eventually we will generate team-specific templates.

**A couple of pointers:**

- Make sure the purpose and context of the document is clear before diving into the details
- If the document describes a technical procedure, explain it in sufficient detail so a non-specialist can follow along or add references to appropriate internal or external sources
- When you make a :ref:`pull request <pullreq>`, add appropriate tags to guide document managers
- Use *inline* **markup** (especially :red:`colors`) appropriately
- Include in-document and external (URL) references where needed\ [1]_
- If possible, use the PNG or SVG file format for images
- Use appropriate ``syntax highlighting`` when including code examples

.. [1] The document manager will assist with setting up references to existing parts of the documentation.

Level 3 heading
===============

Level 4 heading
---------------

Level 5 heading
~~~~~~~~~~~~~~~

.. hint:: This is an hint text block.