conda-smithy rerender
=====================

conda-forge  uses ``conda-smithy`` to re-render the feedstock and update the feedstock configuration.
This action updates the ``README``, CI configuration, the build matrix,
fix problems with the feedstock configuration, etc.

The bot issues re-rendering PRs every now and then,
but sometimes the users may need to issue them manually instead waiting for the bot.
Here is how, and when, to re-render.

How to re-render?
-----------------

First step is to install ``conda-smithy`` in your root environment

.. code-block:: shell
    conda install -c conda-forge conda-smithy


now, from the root directory of the feedstock, type:

.. code-block:: shell
    conda smithy rerender


and commit the changes!

Note that you may get a warning message regarding the tokens.
It is safe to ignore that as they are not needed for re-rendering.

When should we re-render?
-------------------------

We need to re-render when there are changes the following parts of the feedstock:

- the ``yum_requirements.txt``;
- the platform configuration (``skip`` sections);
- build issues that a feedstock configuration update will fix (follow us on `gitter <https://gitter.im/conda-forge/conda-forge.github.io>`_ to know about those);
- updates in the build matrix due to new versions of Python, NumPy, PERL, R, etc.

conda-smithy rerender
=====================

conda-forge  uses ``conda-smithy`` to re-render the feedstock and update the feedstock configuration.
This action updates the ``README``, CI configuration, the build matrix,
fix problems with the feedstock configuration, etc.

The bot issues re-rendering PRs every now and then,
but sometimes the users may need to issue them manually instead waiting for the bot.
Here is how, and when, to re-render.

How to re-render?
-----------------

First step is to install ``conda-smithy`` in your root environment

.. code-block:: shell

    conda install -c conda-forge conda-smithy


now, from the root directory of the feedstock, type:

.. code-block:: shell

    conda smithy rerender


and commit the changes!

Note that you may get a warning message regarding the tokens.
It is safe to ignore that as they are not needed for re-rendering.

When should we re-render?
-------------------------

We need to re-render when there are changes the following parts of the feedstock:

- the ``yum_requirements.txt``;
- the platform configuration (``skip`` sections);
- build issues that a feedstock configuration update will fix (follow us on `gitter <https://gitter.im/conda-forge/conda-forge.github.io>`_ to know about those);
- updates in the build matrix due to new versions of Python, NumPy, PERL, R, etc.

Add empty line after code-block
Add empty line after code-block

Sphinx will otherwise read the following line as more arguments. So
adding a newline helps it to realize this is just content for the
code-block.
