Fixed all H2 headings

Before, H2 fomratting was not consistent.
Now, all H2 headings use over/under asterisks.
This commit is contained in:
Marc Poulin
2018-12-04 13:44:41 -07:00
parent 58fe178325
commit 35c13bc9ea
43 changed files with 532 additions and 203 deletions
+6 -2
View File
@@ -11,15 +11,19 @@ issue on GitHub_. To submit patches, please send a pull request on GitHub_.
Once your changes get merged back in, you'll automatically be added to the
`Contributors List <https://github.com/kennethreitz/python-guide/contributors>`_.
***********
Style Guide
-----------
***********
For all contributions, please follow the :ref:`guide-style-guide`.
.. _todo-list-ref:
*********
Todo List
---------
*********
If you'd like to contribute, there's plenty to do. Here's a short todo_ list.
+24 -8
View File
@@ -19,8 +19,10 @@ The Guide is written as :ref:`restructuredtext-ref`.
.. note:: On any page of the rendered HTML you can click "Show Source" to
see how authors have styled the page.
*********
Relevancy
---------
*********
Strive to keep any contributions relevant to the :ref:`purpose of The Guide
<about-ref>`.
@@ -36,8 +38,10 @@ Strive to keep any contributions relevant to the :ref:`purpose of The Guide
resources, and describe why it's useful to Python.
* When in doubt, ask.
********
Headings
--------
********
Use the following styles for headings.
@@ -71,8 +75,10 @@ Sub section headings:
Very Deep
~~~~~~~~~
*****
Prose
-----
*****
Wrap text lines at 78 characters. Where necessary, lines may exceed 78
characters, especially if wrapping would make the source text more difficult
@@ -85,8 +91,10 @@ from this project, due to complete and total lack of taste.
Banishment? Is this a joke? Hopefully we will never have to find out.
*************
Code Examples
-------------
*************
Wrap all code examples at 70 characters to avoid horizontal scrollbars.
@@ -122,8 +130,10 @@ Python examples:
def get_answer():
return 42
******************
Externally Linking
------------------
******************
* Prefer labels for well known subjects (ex: proper nouns) when linking:
@@ -143,8 +153,10 @@ Externally Linking
* Avoid using labels such as "click here", "this", etc. preferring
descriptive labels (SEO worthy) instead.
********************************
Linking to Sections in The Guide
--------------------------------
********************************
To cross-reference other parts of this documentation, use the `:ref:
<http://sphinx.pocoo.org/markup/inline.html#cross-referencing-arbitrary-locations>`_
@@ -159,8 +171,10 @@ To make reference labels more clear and unique, always add a ``-ref`` suffix:
Some Section
------------
******************
Notes and Warnings
------------------
******************
Make use of the appropriate `admonitions directives
<http://sphinx.pocoo.org/rest.html#directives>`_ when making notes.
@@ -180,8 +194,10 @@ Warnings:
.. warning:: DON'T PANIC
*****
TODOs
-----
*****
Please mark any incomplete areas of The Guide with a `todo directive
<http://sphinx.pocoo.org/ext/todo.html?highlight=todo#directive-todo>`_. To