Skip to content

Commit

Permalink
DOC Add instructions for documentation building (#736)
Browse files Browse the repository at this point in the history
* Add instructions for doc building

* fix rendering

* Update CONTRIBUTING.rst

Co-authored-by: Vincent M <[email protected]>

---------

Co-authored-by: Vincent M <[email protected]>
  • Loading branch information
jovan-stojanovic and Vincent-Maladiere authored Sep 11, 2023
1 parent dcf6061 commit df16844
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ How do I submit an enhancement proposal?
- **If it exists elsewhere, link resources**.

If the enhancement proposal is validated
'''''''''''''''''''''''''''''''
''''''''''''''''''''''''''''''''''''''''

Let maintainers know whether:

Expand Down Expand Up @@ -217,3 +217,47 @@ actions are taken.

Note that by default the documentation is built, but only the examples that are
directly modified by the pull request are executed.

Building the documentation
--------------------------

..
Inspired by: https://github.com/scikit-learn/scikit-learn/blob/main/doc/developers/contributing.rst
**Before submitting a pull request, check if your modifications have introduced
new sphinx warnings by building the documentation locally and try to fix them.**

First, make sure you have `properly installed <https://skrub-data.org/stable/install.html>`__
the development version.

Building the documentation requires installing some additional packages:

.. code:: bash
cd skrub
pip install '.[doc]'
To build the documentation, you need to be in the ``doc`` folder:

.. code:: bash
cd doc
To generate the docs, including the example gallery, you can use:

.. code:: bash
make html
The documentation will be generated in the ``_build/html/`` directory
and are viewable in a web browser, for instance by opening the local
``_build/html/index.html`` file.

This will run all the examples, which takes a while. If you only want to
generate a few examples, you can use:

.. code:: bash
EXAMPLES_PATTERN=your_regex_goes_here make html
This is particularly useful if you are modifying a few examples.

0 comments on commit df16844

Please sign in to comment.