Skip to content

devguide.rst

Latest commit

 

History

History
65 lines (44 loc) · 1.88 KB

devguide.rst

File metadata and controls

65 lines (44 loc) · 1.88 KB

Helping with the Developer's Guide

# deleted the retired ML in the devguide

Developer's Guide workflow

To submit a :ref:`pull request <pullrequest>`, you can fork the devguide repo to your GitHub account and clone it using:

$ git clone https://github.com/<your_username>/devguide

For your PR to be accepted, you will also need to sign the :ref:`contributor agreement <cla>`.

To build the devguide, some additional dependencies are required (most importantly, Sphinx), and the standard way to install dependencies in Python projects is to create a virtualenv, and then install dependencies from a requirements.txt file. For your convenience, this is all automated for you.

To build the devguide from the checkout directory:

.. tab:: Unix/macOS

   .. code-block:: shell

      make html

.. tab:: Windows

   .. code-block:: dosbatch

      .\make html

You will find the generated files in _build/html.

Tip

  • Replace html with htmlview to open the docs in a web browser once the build completes.
  • Replace html with htmllive to rebuild the docs, start a local server, and automatically reload the page in your browser when you make changes to reST files (Unix only).

Note that make check runs automatically when you submit a :ref:`pull request <pullrequest>`. You may wish to run make check and make linkcheck to make sure that it runs without errors.