Skip to content

Commit

Permalink
docs(reST):Add a reST documentation template #142
Browse files Browse the repository at this point in the history
Added a reST documentation creation template.
We have updated the reST index.

closes #142
  • Loading branch information
imAsparky committed Jul 23, 2021
1 parent cb6db79 commit 1e9e566
Show file tree
Hide file tree
Showing 2 changed files with 88 additions and 0 deletions.
87 changes: 87 additions & 0 deletions docs/source/reST/reST-documentation-template.rst
@@ -0,0 +1,87 @@
.. Copy and rename this template in the format reST-doc-title.rst.
.. Update "Template - reST Documentation" with the Documents Title.
.. Update all title-here placeholders with the document title.
.. Update reST-index.rst to include this document.
.. Delete these instructions before pushing the final doc to production.
.. include:: /extras.rst.txt
.. highlight:: rst
.. index:: reST; Title Here
.. _rest-title-here:

=============================
Template - reST Documentation
=============================

|
What is it: One or two lines description

Why does it exist: One or two lines description

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. _how-to-title-here:


How-to
======

How-to: Write one or two lines describing the in-depth explanation
that follows.

Use admonitions, inline-tabs and other reST tools to get a concise
message across.
|

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. _reference-title-here:

Reference
=========

|
:sep:`Many other examples follow below, in the How it Looks and reST syntax
tabs.`

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. index:: reST directives; title-here
.. _reference-title-here:

First Example
-------------

.. tab:: How it Looks

Have reST syntax to render how an example looks here.

.. tab:: reST syntax

.. code-block:: rest
:linenos:
Have the reST syntax here; this should mirror the How it Looks tab.
|
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. _discussion-title-here:

Discussion
==========


+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Further Reading
===============

|
For further interesting reading on this topic, see `Name of the link
<link web address>`__.
1 change: 1 addition & 0 deletions docs/source/reST/reST-index.rst
Expand Up @@ -22,3 +22,4 @@ See a list of the How-to help files we have completed below.
reST-inline-tabs
reST-literalinclude-file
reST-titles-headings
reST-documentation-template

0 comments on commit 1e9e566

Please sign in to comment.