Tianshou/docs/contributing.rst

Contributing to Tianshou
========================


Install Develop Version
-----------------------

To install Tianshou in an "editable" mode, run

.. code-block:: bash

    $ pip install -e ".[dev]"

in the main directory. This installation is removable by

.. code-block:: bash

    $ python setup.py develop --uninstall


PEP8 Code Style Check and Formatting
----------------------------------------

Please set up pre-commit by running

.. code-block:: bash

    $ pre-commit install

in the main directory. This should make sure that your contribution is properly
formatted before every commit.

The code is inspected and formatted by `black` and `ruff`. They are executed as
pre-commit hooks. To format manually you can run e.g.:

.. code-block:: bash

    $ pre-commit run --all-files black
    $ pre-commit run --all-files ruff


Type Check
----------

We use `mypy <https://github.com/python/mypy/>`_ to check the type annotations. To check, in the main directory, run:

.. code-block:: bash

    $ make mypy


Test Locally
------------

This command will run automatic tests in the main directory

.. code-block:: bash

    $ make pytest


Test by GitHub Actions
----------------------

1. Click the ``Actions`` button in your own repo:

.. image:: _static/images/action1.jpg
    :align: center

2. Click the green button:

.. image:: _static/images/action2.jpg
    :align: center

3. You will see ``Actions Enabled.`` on the top of html page.

4. When you push a new commit to your own repo (e.g. ``git push``), it will automatically run the test in this page:

.. image:: _static/images/action3.png
    :align: center


Documentation
-------------

Documentations are written under the ``docs/`` directory as ReStructuredText (``.rst``) files. ``index.rst`` is the main page. A Tutorial on ReStructuredText can be found `here <https://pythonhosted.org/an_example_pypi_project/sphinx.html>`_.

API References are automatically generated by `Sphinx <http://www.sphinx-doc.org/en/stable/>`_ according to the outlines under ``docs/api/`` and should be modified when any code changes.

To compile documentation into webpage, run

.. code-block:: bash

    $ make doc

The generated webpage is in ``docs/_build`` and can be viewed with browser (http://0.0.0.0:8000/).

Chinese documentation is in https://tianshou.readthedocs.io/zh/latest/.


Documentation Generation Test
-----------------------------

We have the following three documentation tests:

1. pydocstyle: test all docstring under ``tianshou/``;

2. doc8: test ReStructuredText format;

3. sphinx test: test if there is any error/warning when generating front-end html documentation.

To check, in the main directory, run:

.. code-block:: bash

    $ make check-docstyle