Skip to content

Commit

Permalink
Elaborate on how to build the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MaozGelbart committed Jul 13, 2020
1 parent 79051ed commit a40e490
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Expand Up @@ -71,10 +71,13 @@ You may instead want to use the development version from Github:
Testing
-------

To test the code, run `make test` in the source directory. This will exercise both the unit tests and docstring examples (using `pytest`).
Testing seaborn requires installing additional packages listed in `ci/utils.txt`.

To test the code, run `make test` in the source directory. This will exercise both the unit tests and docstring examples (using [pytest](https://docs.pytest.org/)).

The doctests require a network connection (unless all example datasets are cached), but the unit tests can be run offline with `make unittests`. Run `make coverage` to generate a test coverage report and `make lint` to check code style consistency.

To build seaborn's documentation, please refer to [how to build the docs?](doc/README.md).

Development
-----------
Expand Down
10 changes: 10 additions & 0 deletions doc/README.md
@@ -0,0 +1,10 @@
How to build the docs?
======================

Building the docs requires installing the dependencies listed in `requirements.txt`.

The building process involves conversion of Jupyter notebooks to `rst` files. To facilitate this you need to set `NB_KERNEL` environment variable to the desired python kernel (e.g. `export NB_KERNEL="python3"`). To get a list of python kernels available, run `jupyter kernelspec list`.

After you're set, from the `doc` directory run `make notebooks html` to convert all notebooks, build all gallery examples and the documentation iteslf. The designated output folder is `_build/html`.

Run `make clean` to delete a built documentation.

0 comments on commit a40e490

Please sign in to comment.