@@ -114,43 +114,38 @@ Testing Documentation
114
114
115
115
To test documentation before a commit:
116
116
117
- * Install Python
117
+ * Install ` Sphinx `_;
118
118
119
- * Install Sphinx
119
+ * Run the ` Sphinx quick setup `_;
120
120
121
- * Run the Sphinx quick setup
121
+ * Install the configuration-block Sphinx extension (see below);
122
+
123
+ * Run ``make html `` and view the generated HTML in the ``build `` directory.
124
+
125
+ Installing the configuration-block Sphinx extension
126
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122
127
123
- * Install the configuration-block Sphinx extension (see below)
124
-
125
-
126
- Installing the configuration-block Sphinx extension
127
- ++++++++++++++++++++++++++++++++++++++++++++++++++++
128
128
* Download the extension from the `configuration-block source `_ repository
129
129
130
- * Copy the configurationblock.py to the _exts folder under your source folder (where conf.py is located)
130
+ * Copy the ``configurationblock.py `` to the ``_exts `` folder under your
131
+ source folder (where ``conf.py `` is located)
131
132
132
- * Add the following to the conf.py file (taken from the doctrine orm-docs) :
133
+ * Add the following to the `` conf.py `` file:
133
134
134
135
.. code-block :: py
135
136
136
137
# ...
137
-
138
- # If extensions (or modules to document with autodoc) are in another directory,
139
- # add these directories to sys.path here. If the directory is relative to the
140
- # documentation root, use os.path.abspath to make it absolute, like shown here.
141
138
sys.path.append(os.path.abspath(' _exts' ))
142
139
143
- # -- General configuration -----------------------------------------------------
144
-
145
- # Add any Sphinx extension module names here, as strings. They can be extensions
146
- # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
140
+ # ...
141
+ # add configurationblock to the list of extensions
147
142
extensions = [' configurationblock' ]
148
143
149
-
150
144
.. _reStructuredText : http://docutils.sf.net/rst.html
151
145
.. _Sphinx : http://sphinx.pocoo.org/
152
146
.. _documents : http://github.com/symfony/symfony-docs
153
147
.. _reStructuredText Primer : http://sphinx.pocoo.org/rest.html
154
148
.. _markup : http://sphinx.pocoo.org/markup/
155
149
.. _Pygments website : http://pygments.org/languages/
156
150
.. _configuration-block source : https://github.com/fabpot/sphinx-php
151
+ .. _Sphinx quick setup : http://sphinx.pocoo.org/tutorial.html#setting-up-the-documentation-sources
0 commit comments