Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(reST):Add a reST documentation template #142
Added a reST documentation creation template. We have updated the reST index. closes #142
- Loading branch information
Showing
2 changed files
with
88 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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>`__. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters