From 023a35c3b49bb97ddc45724a4f812ff962b610c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Mesejo-Le=C3=B3n?= Date: Fri, 3 Apr 2020 14:53:27 +0200 Subject: [PATCH] Add instructions for how to build docs --- CONTRIBUTING.md | 7 ++++--- docs/requirements-docs.txt | 2 +- docs/source/conf.py | 2 +- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad3eb9a..3962c07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -155,14 +155,15 @@ currently using a minimum version of PyCharm 2019.2.4. `python -m eland.tests.setup_tests` to setup test environment -*note this modifies Elasticsearch indices* - Install local `eland` module (required to execute notebook tests) - `python install setup.py` -- Run `pytest --nbval --doctest-modules` to validate install + `python setup.py install` +- Run `pytest --nbval` to validate install - To test specific versions of Python use `nox -s test-3.8` - To run the automatic formatter and check for lint issues run `nox -s blacken` ### Documentation - +- [Install pandoc on your system](https://pandoc.org/installing.html) + For Ubuntu or Debian you can do `sudo apt-get install -y pandoc` - Install documentation requirements. Open terminal in virtual environment and run `pip install -r docs/requirements-docs.txt` diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 7c05f4d..2de725e 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -2,7 +2,7 @@ elasticsearch>=7.0.5 pandas>=1 matplotlib pytest>=5.2.1 -git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master +git+https://github.com/pandas-dev/pydata-sphinx-theme.git@master numpydoc>=0.9.0 nbsphinx scikit-learn diff --git a/docs/source/conf.py b/docs/source/conf.py index b72296a..10946b5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -113,7 +113,7 @@ exclude_patterns = ["**.ipynb_checkpoints"] # a list of builtin themes. # # html_theme = 'sphinx_rtd_theme' -html_theme = "pandas_sphinx_theme" +html_theme = "pydata_sphinx_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files,