chore(files):Added folder, rename files for TOC #62

Style guides folder created and style files moved to improve TOC useability
imAsparky · Jul 19, 2021 · 130809b · 130809b
1 parent ba723a5
commit 130809b
Show file tree

Hide file tree

Showing 7 changed files with 98 additions and 106 deletions.
diff --git a/docs/source/style-developer.rst → docs/source/Style/style-developer.rst b/docs/source/style-developer.rst → docs/source/Style/style-developer.rst
@@ -1,20 +1,20 @@
 .. include:: /extras.rst.txt
 
 
-====================
-**Developer Styles**
-====================
+================
+Developer Styles
+================
 
 |
 
-**Git**
-=======
+Git
+===
 
 |
 
 
-**Commit Message**
-------------------
+Commit Message
+--------------
 
 |
 
@@ -86,8 +86,8 @@ The git commit message follows the
 |
 
 
-**CHANGELOG**
---------------
+CHANGELOG
+---------
 
 |
 

diff --git a/docs/source/style-guide.rst → docs/source/Style/style-guide-intro.rst b/docs/source/style-guide.rst → docs/source/Style/style-guide-intro.rst
@@ -2,25 +2,17 @@
 .. index:: style; Style Guide
 .. _style-guide-intro:
 
-===============
-**Style Guide**
-===============
+===========
+Style Guide
+===========
 
-.. sidebar:: Optional Sidebar Title
-      :subtitle: Optional Sidebar Subtitle
-
-      Subsequent indented lines comprise
-      the body of the sidebar, and are
-      interpreted as body elements.
-
-
-**What**
---------
+What
+----
 
 Style guides provide guidelines for presenting your Brand from a visual and written perspective.
 
-**How**
--------
+How
+---
 Provide well-written style guides developed from six essential areas:
 
 #. Your story.
@@ -30,15 +22,15 @@ Provide well-written style guides developed from six essential areas:
 #. Your imagery.
 #. and Typography.
 
-**Why**
--------
+Why
+---
 Style guides establish consistent usage of language and layout across several different contributors.
 
 Well structured and written style guides, including layouts for the four pillars of Diátaxis content framework, reduce the load on technical and content creators.
 
 
-**When**
---------
+When
+----
 
 Right now is an excellent time to start.
 
@@ -52,11 +44,3 @@ See our list of style guides below.
 .. tip::
 
    Style guides are under construction... More to come : )
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Style Guides:
-
-
-   style-developer.rst
-   style-rst
diff --git a/docs/source/style-guide-reference.rst → docs/source/Style/style-guide-reference.rst b/docs/source/style-guide-reference.rst → docs/source/Style/style-guide-reference.rst
diff --git a/docs/source/style-index.rst → docs/source/Style/style-index.rst b/docs/source/style-index.rst → docs/source/Style/style-index.rst
@@ -3,11 +3,13 @@
 .. index:: Style; Reference
 .. _rest-reference:
 
-=======================
-reST & Sphinx reference
-=======================
+============
+Style Guides
+============
 
 .. toctree::
    :titlesonly:
 
-   style-developers
+   style-guide-intro
+   style-developer
+   style-rst
diff --git a/docs/source/style-rst.rst → docs/source/Style/style-rst.rst b/docs/source/style-rst.rst → docs/source/Style/style-rst.rst
@@ -1,18 +1,19 @@
 .. include:: /extras.rst.txt
 
-===========================
-**reStructured Text Style**
-===========================
+=======================
+reStructured Text Style
+=======================
 
-There may be a need to modify one of the pre-existing templates or create a new one to improve how the author can convey their message.
+There may be a need to modify one of the pre-existing templates or
+create a new one to improve how the author can convey their message.
 
 For those occasions, here is Junction Box's reST styling guide.
 
-**Text Emphasis**
-=================
+Text Emphasis
+=============
 
-**Bold and Italic**
--------------------
+Bold and Italic
+---------------
 
 Sphinx can render text as either bold or italic but not both.
 
@@ -28,8 +29,8 @@ Sphinx can render text as either bold or italic but not both.
 Normal text, **bold text** and *italic text*.
 
 
-**Line Spaces**
-----------------
+Line Spaces
+-----------
 
 Line spaces can help emphasise text in some cases.
 
@@ -80,8 +81,8 @@ Text on line 6
 
 .. _document-headings:
 
-**Document Headings**
-=====================
+Document Headings
+=================
 
 In reST, you can use different underlining styles in any order.
 
@@ -90,49 +91,49 @@ For reST (.rst) Title and Heading styles, see below.
 .. code-block:: rest
    :linenos:
 
-      ============
-      **DocTitle**
-      ============
+      ========
+      DocTitle
+      ========
 
-      **Heading 1**
-      =============
+      Heading 1
+      =========
 
-      **Heading 1.1**
-      ---------------
+      Heading 1.1
+      -----------
 
-      **Heading 1.1.1**
-      ~~~~~~~~~~~~~~~~~
+      Heading 1.1.1
+      ~~~~~~~~~~~~~
 
-      **Heading 1.1.1.1**
-      """""""""""""""""""
+      Heading 1.1.1.1
+      """""""""""""""
 
 |
 
 *See the styling above rendered by Sphinx below.*
 
-============
-**DocTitle**
-============
+========
+DocTitle
+========
 
-**Heading 1**
-=============
+Heading 1
+=========
 
-**Heading 1.1**
----------------
+Heading 1.1
+-----------
 
-**Heading 1.1.1**
-~~~~~~~~~~~~~~~~~
+Heading 1.1.1
+~~~~~~~~~~~~~~~
 
-**Heading 1.1.1.1**
-"""""""""""""""""""
+Heading 1.1.1.1
+"""""""""""""""
 
 |
 
-**Links**
-=========
+Links
+=====
 
-**Link to a Heading**
----------------------
+Link to a Heading
+-----------------
 
 Sphinx provides the ability to link to internal document references.
 
@@ -164,10 +165,7 @@ Sphinx provides the ability to link to internal document references.
 
 .. _random-heading-link:
 
-**Random Heading**
-==================
-
-Some random text to help some unexpected challenge.
+ndom Heading============Some random text to help some unexpected challenge.
 
 |
 |
@@ -190,10 +188,20 @@ See here :ref:`random-heading-link` for information to help with your unexpected
    The \:ref:\`random heading-link\` text is surrounded by backticks,
    not single apostrophe's!
 
+|
+|
+
+.. .. sidebar:: Optional Sidebar Title
+..       :subtitle: Optional Sidebar Subtitle
+
+..       Subsequent indented lines comprise
+..       the body of the sidebar, and are
+..       interpreted as body elements.
+
 
 
-**Admonitions**
-===============
+.. **Admonitions**
+.. ===============
 
 .. https://docutils.sourceforge.io/0.4/docs/ref/rst/directives.html#specific-admonitions
 .. https://docutils.sourceforge.io/0.4/docs/howto/rst-directives.html
diff --git a/docs/source/about.rst b/docs/source/about.rst
@@ -1,6 +1,6 @@
-=========
-**About**
-=========
+=====
+About
+=====
 
 |
 
@@ -9,25 +9,25 @@ JUNCTION BOX
 
 |
 
-**What's in a name?**
----------------------
+What's in a name?
+-----------------
 
 The process of writing software is very similar to the electrical trade in the sense that things are wired up or connected.
 
 Hence the name **Junction Box**, a place where things are connected.
 
 |
 
-**Overview**
-------------
+Overview
+--------
 |
 
 This project is about documenting how we use several technologies that meet the needs of our software development initiatives.
 
 |
 
-**What**
---------
+What
+----
 
 |
 
@@ -50,8 +50,8 @@ When how we use the first two items has been  documented, other technologies on
 
 |
 
-**How**
--------
+How
+---
 |
 
 #. Create and follow a style guide.
@@ -61,8 +61,8 @@ When how we use the first two items has been  documented, other technologies on
 
 |
 
-**Why**
--------
+Why
+---
 
 |
 
@@ -85,20 +85,20 @@ When it is needed, good documentation can ease the load of remembering.
 
 |
 
-**When**
---------
+When
+----
 |
 
 Following Continuous Delivery Principles, this is a living document.
 
 |
 
-**The Author**
---------------
+The Author
+----------
 |
 
 Mark Sevelj has an electrical trade background.
 
 Roles where often technical and using Python and pandas for data analysis was a lot faster than excel.
 
-A need to formalise and document these scripts and workflows is now the purpose of this endeavour.
+A need to formalise and document these scripts and workflows is the purpose of this project.