<commit_before>Read the Docs YAML Config
=========================

Read the Docs now has support for configuring builds with a YAML file.
The file, ``readthedocs.yml`` (or ``.readthedocs.yml``), must be in the root directory of your project.

.. warning:: This feature is in a beta state.
             Please file an `issue`_ if you find anything wrong.


Here is an example of how this file looks like:

.. code:: yaml

   # .readthedocs.yml

   build:
     image: latest
   
   python:
     version: 3.6
     setup_py_install: true


Supported settings
------------------

.. _yaml__formats:

formats
~~~~~~~

* Default: ``htmlzip``, ``pdf``, ``epub``
* Options: ``htmlzip``, ``pdf``, ``epub``
* Type: List of options or ``null``

The formats of your documentation you want to be built.
Set as an empty list ``[]`` 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.

.. code-block:: yaml

    # Don't build any extra formats
    formats: []

.. code-block:: yaml

    # Build PDF & ePub
    formats:<commit_msg>Update formats spec<commit_after>Read the Docs YAML Config
=========================

Read the Docs now has support for configuring builds with a YAML file.
The file, ``readthedocs.yml`` (or ``.readthedocs.yml``), must be in the root directory of your project.

.. warning:: This feature is in a beta state.
             Please file an `issue`_ if you find anything wrong.


Here is an example of how this file looks like:

.. code:: yaml

   # .readthedocs.yml

   build:
     image: latest
   
   python:
     version: 3.6
     setup_py_install: true


Supported settings
------------------

.. _yaml__formats:

formats
~~~~~~~

* Default: [``htmlzip``, ``pdf``, ``epub``]
* Options: ``htmlzip``, ``pdf``, ``epub``
* Type: List

The formats of your documentation you want to be built.
Set as an empty list ``[]`` 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.

.. code-block:: yaml

    # Don't build any extra formats
    formats: []

.. code-block:: yaml

    # Build PDF & ePub
    formats:
{'fraction_non_alphanumeric': 0.14759169244365886, 'fraction_numerical': 0.0017675651789659744, 'mean_word_length': 2.937391304347826, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3472649', 'n_tokens_mistral': 707, 'n_tokens_neox': 660, 'n_words': 285}