diff options
| author | Steve Piercy <web@stevepiercy.com> | 2016-11-28 23:14:16 -0800 |
|---|---|---|
| committer | Steve Piercy <web@stevepiercy.com> | 2016-11-28 23:14:16 -0800 |
| commit | b99ada66150f9155ed959338f2053e544a6c8265 (patch) | |
| tree | 686e3181e6b2c572297ab13c53e37683b30a6c64 /docs/style-guide.rst | |
| parent | 08a026807782b05ba9b171803d2cd6876338e0fc (diff) | |
| download | pyramid-b99ada66150f9155ed959338f2053e544a6c8265.tar.gz pyramid-b99ada66150f9155ed959338f2053e544a6c8265.tar.bz2 pyramid-b99ada66150f9155ed959338f2053e544a6c8265.zip | |
restore Typographical Conventions, an edited and condensed version of the Style Guide
Diffstat (limited to 'docs/style-guide.rst')
| -rw-r--r-- | docs/style-guide.rst | 34 |
1 files changed, 12 insertions, 22 deletions
diff --git a/docs/style-guide.rst b/docs/style-guide.rst index 70f899651..bdca45a06 100644 --- a/docs/style-guide.rst +++ b/docs/style-guide.rst @@ -293,31 +293,21 @@ As individual files do not have so-called "parts" or "chapters", the headings wo .. code-block:: rst - Heading Level 1 - =============== + ================================== + The main heading or web page title + ================================== - Heading Level 2 + Heading Level 1 --------------- - Heading Level 3 + Heading Level 2 ^^^^^^^^^^^^^^^ - Heading Level 4 + Heading Level 3 """"""""""""""" -The above code renders as follows. - -Heading Level 1 -=============== - -Heading Level 2 ---------------- +Note, we do not render heading levels here because doing so causes a loss in page structure. -Heading Level 3 -^^^^^^^^^^^^^^^ - -Heading Level 4 -""""""""""""""" .. _style-guide-paragraphs: @@ -375,7 +365,7 @@ The above code renders as follows. Displaying code ^^^^^^^^^^^^^^^ -Code may be displayed in blocks or inline. You can include blocks of code from other source files. Blocks of code should use syntax highlighting. +Code may be displayed in blocks or inline. You can include blocks of code from other source files. Blocks of code should use syntax highlighting, and may use line numbering or emphasis. .. seealso:: See also the Sphinx documentation for :ref:`code-examples`. @@ -427,10 +417,10 @@ cfg: .. code-block:: cfg - [some-part] - # A random part in the buildout - recipe = collective.recipe.foo - option = value + [some-part] + # A random part in the buildout + recipe = collective.recipe.foo + option = value ini: |