mirror of
https://github.com/elastic/eland.git
synced 2025-07-11 00:02:14 +08:00
6564f26245
Adding contributing section based on Elasticsearch/CONTRIBUTING.md TODO - add testing docs (based on CI)1
98 lines
2.9 KiB
Python
98 lines
2.9 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
import os
|
|
import sys
|
|
sys.path.insert(0, os.path.abspath("../sphinxext"))
|
|
sys.path.extend(
|
|
[
|
|
# numpy standard doc extensions
|
|
os.path.join(os.path.dirname(__file__), "..", "../..", "sphinxext")
|
|
]
|
|
)
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'eland'
|
|
copyright = '2019, Elasticsearch B.V.'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = '0.1'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
"sphinx.ext.doctest",
|
|
"sphinx.ext.extlinks",
|
|
'numpydoc',
|
|
"matplotlib.sphinxext.plot_directive",
|
|
"sphinx.ext.todo",
|
|
]
|
|
|
|
doctest_global_setup = '''
|
|
try:
|
|
import eland as ed
|
|
except ImportError:
|
|
ed = None
|
|
try:
|
|
import pandas as pd
|
|
except ImportError:
|
|
pd = None
|
|
'''
|
|
|
|
extlinks = {
|
|
'pandas_api_docs': ('https://pandas.pydata.org/pandas-docs/version/0.25.1/reference/api/%s.html', ''),
|
|
'pandas_user_guide': ('https://pandas.pydata.org/pandas-docs/stable/user_guide/%s.html', 'Pandas User Guide/'),
|
|
'es_api_docs': ('https://www.elastic.co/guide/en/elasticsearch/reference/current/%s.html', '')
|
|
}
|
|
|
|
numpydoc_attributes_as_param_list = False
|
|
numpydoc_show_class_members = False
|
|
|
|
# matplotlib plot directive
|
|
plot_include_source = True
|
|
plot_formats = [("png", 90)]
|
|
plot_html_show_formats = False
|
|
plot_html_show_source_link = False
|
|
plot_pre_code = """import numpy as np
|
|
import eland as ed"""
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = []
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
#html_theme = 'sphinx_rtd_theme'
|
|
html_theme = "pandas_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,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
#html_static_path = ['_static']
|