Use yaml types
@@ -29,10 +29,11 @@ formats
~~~~~~~
* Default: ``htmlzip``, ``pdf``, ``epub``
-* Options: ``htmlzip``, ``pdf``, ``epub``, ``none``
+* Options: ``htmlzip``, ``pdf``, ``epub``, ``null``
+* Type: List of options or ``null``
The formats of your documentation you want to be built.
-Choose ``none`` to build none of the formats.
+Choose ``null`` to build none of the formats.
.. note:: We will always build an HTML & JSON version of your documentation.
These are used for web serving & search indexing, respectively.
@@ -41,7 +42,7 @@ Choose ``none`` to build none of the formats.
# Don't build any extra formats
formats:
- - none
+ - null
.. code-block:: yaml
@@ -53,16 +54,15 @@ Choose ``none`` to build none of the formats.
requirements_file
~~~~~~~~~~~~~~~~~
-* Default: `None`
+* Default: ``null``
* Type: Path (specified from the root of the project)
-The path to your Pip requirements file.
+The path to your pip requirements file.
.. code-block:: yaml
requirements_file: requirements/docs.txt
-
conda
~~~~~
@@ -71,12 +71,11 @@ The ``conda`` block allows for configuring our support for Conda.
conda.file
``````````
-* Default: `None`
+* Default: ``null``
* Type: Path (specified from the root of the project)
The file option specified the Conda `environment file`_ to use.
-
.. code-block:: yaml
conda:
@@ -84,7 +83,6 @@ The file option specified the Conda `environment file`_ to use.
.. note:: Conda is only supported via the YAML file.
-
build
~~~~~
@@ -95,7 +93,6 @@ The ``build`` block configures specific aspects of the documentation build.
build.image
```````````
-
* Default: :djangosetting:`DOCKER_IMAGE`
* Options: ``1.0``, ``2.0``, ``latest``
@@ -130,9 +127,9 @@ python.version
* Default: ``2.7``
* Options: ``2.7``, ``2``, ``3.5``, ``3``
-This is the version of Python to use when building your documentation. If you
-specify only the major version of Python, the highest supported minor version
-will be selected.
+This is the version of Python to use when building your documentation.
+If you specify only the major version of Python,
+the highest supported minor version will be selected.
.. warning::
@@ -149,7 +146,7 @@ will be selected.
python.setup_py_install
```````````````````````
-* Default: `False`
+* Default: ``false``
* Type: Boolean
When true, install your project into the Virtualenv with
@@ -163,10 +160,10 @@ When true, install your project into the Virtualenv with
python.pip_install
``````````````````
-* Default: `False`
+* Default: ``false``
* Type: Boolean
-When true, install your project into the Virtualenv with pip when building
+When ``true``, install your project into the virtualenv with pip when building
documentation.
.. code-block:: yaml
@@ -210,7 +207,7 @@ python.extra_requirements
List of `extra requirements`_ sections to install, additionally to the
`package default dependencies`_. Only works if ``python.pip_install`` option
-above is set to ``True``.
+above is set to ``true``.
Let's say your Python package has a ``setup.py`` which looks like this:
