6ddbea207f
Because sphinx itself supports typehints now, and a recent update to plugin caused it to start spewing massive amounts of warnings.
92 lines
3.3 KiB
Python
92 lines
3.3 KiB
Python
"""Configuration file for the Sphinx documentation builder."""
|
|
|
|
# Reference: http://www.sphinx-doc.org/en/master/config
|
|
|
|
from typing import List
|
|
|
|
import pkg_resources
|
|
|
|
|
|
# pylint: disable=invalid-name
|
|
# because these variables are not named in upper case, as globals should be.
|
|
|
|
project = "0x-contract-wrappers"
|
|
# pylint: disable=redefined-builtin
|
|
copyright = "2019, ZeroEx, Intl."
|
|
author = "Michael Huang"
|
|
version = pkg_resources.get_distribution("0x-contract-wrappers").version
|
|
release = "" # The full version, including alpha/beta/rc tags
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.doctest",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.coverage",
|
|
"sphinx.ext.viewcode",
|
|
]
|
|
|
|
templates_path = ["doc_templates"]
|
|
|
|
source_suffix = ".rst"
|
|
# eg: source_suffix = [".rst", ".md"]
|
|
|
|
master_doc = "index" # The master toctree document.
|
|
|
|
language = None
|
|
|
|
exclude_patterns: List[str] = []
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = None
|
|
|
|
html_theme = "alabaster"
|
|
|
|
html_static_path = ["doc_static"]
|
|
# 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".
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = "contract_wrapperspydoc"
|
|
|
|
# -- Extension configuration:
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
intersphinx_mapping = {"https://docs.python.org/": None}
|
|
|
|
|
|
def annotate_gend_tuple_docstring( # pylint: disable=too-many-arguments
|
|
app, # pylint: disable=unused-argument
|
|
what, # pylint: disable=unused-argument
|
|
name, # pylint: disable=unused-argument
|
|
obj, # pylint: disable=unused-argument
|
|
options, # pylint: disable=unused-argument
|
|
lines,
|
|
):
|
|
"""Annotate docstrings of generated tuples."""
|
|
docstring_extensions = {
|
|
"LibOrderOrder": [
|
|
"This is the generated class representing `the Order struct <https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md#order>`_."
|
|
],
|
|
"LibFillResultsFillResults": [
|
|
"This is the generated class representing `the FillResults struct <https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md#fillresults>`_."
|
|
],
|
|
"LibFillResultsMatchedFillResults": [
|
|
"This is the generated class representing `the MatchedFillResults struct <https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md#matchedfillresults>`_."
|
|
],
|
|
"LibOrderOrderInfo": [
|
|
"This is the generated class representing `the OrderInfo struct <https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md#orderinfo>`_."
|
|
],
|
|
"LibZeroExTransactionZeroExTransaction": [
|
|
"This is the generated class representing `the ZeroExTransaction struct <https://github.com/0xProject/0x-protocol-specification/blob/master/v3/v3-specification.md#zeroextransaction>`_."
|
|
],
|
|
}
|
|
unqualified_name = name.split(".")[-1]
|
|
if unqualified_name in docstring_extensions:
|
|
lines.extend(docstring_extensions[unqualified_name])
|
|
|
|
|
|
def setup(app):
|
|
"""Install callbacks."""
|
|
app.connect("autodoc-process-docstring", annotate_gend_tuple_docstring)
|