third_codes/eland
1
0
Fork 0
mirror of https://github.com/elastic/eland.git synced 2025-07-11 00:02:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add instructions for how to build docs

Browse Source
This commit is contained in:
Daniel Mesejo-León 2020-04-03 14:53:27 +02:00 committed by GitHub
parent c8bd25cbea
commit 023a35c3b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -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 `python -m eland.tests.setup_tests` to setup test environment -*note
this modifies Elasticsearch indices* this modifies Elasticsearch indices*
- Install local `eland` module (required to execute notebook tests) - Install local `eland` module (required to execute notebook tests)
`python install setup.py` `python setup.py install`
- Run `pytest --nbval --doctest-modules` to validate install - Run `pytest --nbval` to validate install
- To test specific versions of Python use `nox -s test-3.8` - To test specific versions of Python use `nox -s test-3.8`
- To run the automatic formatter and check for lint issues - To run the automatic formatter and check for lint issues
run `nox -s blacken` run `nox -s blacken`
### Documentation ### 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 - Install documentation requirements. Open terminal in virtual
environment and run `pip install -r docs/requirements-docs.txt` environment and run `pip install -r docs/requirements-docs.txt`

2
docs/requirements-docs.txt
View File

@ -2,7 +2,7 @@ elasticsearch>=7.0.5
pandas>=1 pandas>=1
matplotlib matplotlib
pytest>=5.2.1 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 numpydoc>=0.9.0
nbsphinx nbsphinx
scikit-learn scikit-learn

2
docs/source/conf.py
View File

@ -113,7 +113,7 @@ exclude_patterns = ["**.ipynb_checkpoints"]
# a list of builtin themes. # a list of builtin themes.
# #
# html_theme = 'sphinx_rtd_theme' # 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, # 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, # relative to this directory. They are copied after the builtin static files,