<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
------------------

formats
~~~~~~~

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

The formats of your documentation you want to be built.
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.

.. code-block:: yaml

    # Don't build any extra formats
    formats:
        - null

.. code-block:: yaml

    # Build PDF & ePub
    formats:
        - epub
        - pdf

requirements_file
~~~~~~~~~~~~~~~~~

* Default: ``null``
* Type: Path (specified from the root of the project)

The path to your pip requirements file.

.. code-block:: yaml

	requirements_file: requirements/docs.txt

conda
~~~~~

The ``conda`` block allows for configuring our support for Conda.

conda.file
``````````

* 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:
	    file: environment.yml

.. note:: Conda is only supported via the YAML file.
<commit_msg>Indentation<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
------------------

formats
~~~~~~~

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

The formats of your documentation you want to be built.
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.

.. code-block:: yaml

    # Don't build any extra formats
    formats:
        - null

.. code-block:: yaml

    # Build PDF & ePub
    formats:
        - epub
        - pdf

requirements_file
~~~~~~~~~~~~~~~~~

* Default: ``null``
* Type: Path (specified from the root of the project)

The path to your pip requirements file.

.. code-block:: yaml

   requirements_file: requirements/docs.txt

conda
~~~~~

The ``conda`` block allows for configuring our support for Conda.

conda.file
``````````

* 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:
	    file: environment.yml

.. note:: Conda is only supported via the YAML file.

{'fraction_non_alphanumeric': 0.14549653579676675, 'fraction_numerical': 0.0011547344110854503, 'mean_word_length': 3.024390243902439, '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': '5407424', 'n_tokens_mistral': 1086, 'n_tokens_neox': 1018, 'n_words': 428}