| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 6753406 commit 4428d87
1 file changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -39,24 +39,32 @@ Headings | |||
| 39 | 39 | ||
| 40 | 40 | Use the following styles for headings. | |
| 41 | 41 | ||
| 42 | - Chapter title:: | ||
| 42 | + Chapter title: | ||
| 43 | + | ||
| 44 | + .. code-block:: rest | ||
| 43 | 45 | ||
| 44 | 46 | ######### | |
| 45 | 47 | Chapter 1 | |
| 46 | 48 | ######### | |
| 47 | 49 | ||
| 48 | - Page title:: | ||
| 50 | + Page title: | ||
| 51 | + | ||
| 52 | + .. code-block:: rest | ||
| 49 | 53 | ||
| 50 | 54 | =================== | |
| 51 | 55 | Time is an Illusion | |
| 52 | 56 | =================== | |
| 53 | 57 | ||
| 54 | - Section headings:: | ||
| 58 | + Section headings: | ||
| 59 | + | ||
| 60 | + .. code-block:: rest | ||
| 55 | 61 | ||
| 56 | 62 | Lunchtime Doubly So | |
| 57 | 63 | ------------------- | |
| 58 | 64 | ||
| 59 | - Sub section headings:: | ||
| 65 | + Sub section headings: | ||
| 66 | + | ||
| 67 | + .. code-block:: rest | ||
| 60 | 68 | ||
| 61 | 69 | Very Deep | |
| 62 | 70 | ~~~~~~~~~ | |
@@ -74,7 +82,9 @@ Code Examples | |||
| 74 | 82 | ||
| 75 | 83 | Wrap all code examples at 70 characters to avoid horizontal scrollbars. | |
| 76 | 84 | ||
| 77 | - Command line examples:: | ||
| 85 | + Command line examples: | ||
| 86 | + | ||
| 87 | + .. code-block:: rest | ||
| 78 | 88 | ||
| 79 | 89 | .. code-block:: console | |
| 80 | 90 | ||
@@ -83,15 +93,19 @@ Command line examples:: | |||
| 83 | 93 | ||
| 84 | 94 | Be sure to include the ``$`` prefix before each line. | |
| 85 | 95 | ||
| 86 | - Python interpreter examples:: | ||
| 96 | + Python interpreter examples: | ||
| 97 | + | ||
| 98 | + .. code-block:: rest | ||
| 87 | 99 | ||
| 88 | 100 | Label the example:: | |
| 89 | 101 | ||
| 90 | 102 | .. code-block:: python | |
| 91 | 103 | ||
| 92 | 104 | >>> import this | |
| 93 | 105 | ||
| 94 | - Python examples:: | ||
| 106 | + Python examples: | ||
| 107 | + | ||
| 108 | + .. code-block:: rest | ||
| 95 | 109 | ||
| 96 | 110 | Descriptive title:: | |
| 97 | 111 | ||
@@ -103,16 +117,20 @@ Python examples:: | |||
| 103 | 117 | Externally Linking | |
| 104 | 118 | ------------------ | |
| 105 | 119 | ||
| 106 | - * Prefer labels for well known subjects (ex: proper nouns) when linking:: | ||
| 120 | + * Prefer labels for well known subjects (ex: proper nouns) when linking: | ||
| 121 | + | ||
| 122 | + .. code-block:: rest | ||
| 107 | 123 | ||
| 108 | - Sphinx_ is used to document Python. | ||
| 124 | + Sphinx_ is used to document Python. | ||
| 109 | 125 | ||
| 110 | - .. _Sphinx: http://sphinx.pocoo.org | ||
| 126 | + .. _Sphinx: http://sphinx.pocoo.org | ||
| 111 | 127 | ||
| 112 | 128 | * Prefer to use descriptive labels with inline links instead of leaving bare | |
| 113 | - links:: | ||
| 129 | + links: | ||
| 130 | + | ||
| 131 | + .. code-block:: rest | ||
| 114 | 132 | ||
| 115 | - Read the `Sphinx Tutorial <http://sphinx.pocoo.org/tutorial.html>`_ | ||
| 133 | + Read the `Sphinx Tutorial <http://sphinx.pocoo.org/tutorial.html>`_ | ||
| 116 | 134 | ||
| 117 | 135 | * Avoid using labels such as "click here", "this", etc. preferring | |
| 118 | 136 | descriptive labels (SEO worthy) instead. | |
@@ -124,7 +142,9 @@ To cross-reference other parts of this documentation, use the `:ref: | |||
| 124 | 142 | <http://sphinx.pocoo.org/markup/inline.html#cross-referencing-arbitrary-locations>`_ | |
| 125 | 143 | keyword and labels. | |
| 126 | 144 | ||
| 127 | - To make reference labels more clear and unique, always add a ``-ref`` suffix:: | ||
| 145 | + To make reference labels more clear and unique, always add a ``-ref`` suffix: | ||
| 146 | + | ||
| 147 | + .. code-block:: rest | ||
| 128 | 148 | ||
| 129 | 149 | .. _some-section-ref: | |
| 130 | 150 | ||
@@ -137,14 +157,18 @@ Notes and Warnings | |||
| 137 | 157 | Make use of the appropriate `admonitions directives | |
| 138 | 158 | <http://sphinx.pocoo.org/rest.html#directives>`_ when making notes. | |
| 139 | 159 | ||
| 140 | - Notes:: | ||
| 160 | + Notes: | ||
| 161 | + | ||
| 162 | + .. code-block:: rest | ||
| 141 | 163 | ||
| 142 | 164 | .. note:: | |
| 143 | 165 | The Hitchhiker’s Guide to the Galaxy has a few things to say | |
| 144 | 166 | on the subject of towels. A towel, it says, is about the most | |
| 145 | 167 | massively useful thing an interstellar hitch hiker can have. | |
| 146 | 168 | ||
| 147 | - Warnings:: | ||
| 169 | + Warnings: | ||
| 170 | + | ||
| 171 | + .. code-block:: rest | ||
| 148 | 172 | ||
| 149 | 173 | .. warning:: DON'T PANIC | |
| 150 | 174 | ||
@@ -156,7 +180,7 @@ Please mark any incomplete areas of The Guide with a `todo directive | |||
| 156 | 180 | avoid cluttering the :ref:`todo-list-ref`, use a single ``todo`` for stub | |
| 157 | 181 | documents or large incomplete sections. | |
| 158 | 182 | ||
| 159 | - :: | ||
| 183 | + .. code-block:: rest | ||
| 160 | 184 | ||
| 161 | 185 | .. todo:: | |
| 162 | 186 | Learn the Ultimate Answer to the Ultimate Question | |
| Back | FazBrowse Home | New Git URL |
0 commit comments