aboutsummaryrefslogtreecommitdiffstats
path: root/python-packages/order_utils/src/conf.py
diff options
context:
space:
mode:
authorF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-10-11 00:14:20 +0800
committerF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-10-13 03:31:19 +0800
commit92fd0a9d24378d01d87dfa6fd0ec5a42edfe8308 (patch)
tree0f3f9a79e140748775f01af7e8b87bd36f497ed7 /python-packages/order_utils/src/conf.py
parentf3cba233ad84b1c8191e91f35b72faa6a64078fa (diff)
downloaddexon-0x-contracts-92fd0a9d24378d01d87dfa6fd0ec5a42edfe8308.tar.gz
dexon-0x-contracts-92fd0a9d24378d01d87dfa6fd0ec5a42edfe8308.tar.zst
dexon-0x-contracts-92fd0a9d24378d01d87dfa6fd0ec5a42edfe8308.zip
feat: project stub for python order utilities
An empty project, with respect to functionality, but one configured with a test framework, linters, CI integration, etc. https://app.asana.com/0/836857747873847/839549782781239/f
Diffstat (limited to 'python-packages/order_utils/src/conf.py')
-rw-r--r--python-packages/order_utils/src/conf.py50
1 files changed, 50 insertions, 0 deletions
diff --git a/python-packages/order_utils/src/conf.py b/python-packages/order_utils/src/conf.py
new file mode 100644
index 000000000..f3f15967c
--- /dev/null
+++ b/python-packages/order_utils/src/conf.py
@@ -0,0 +1,50 @@
+"""Configuration file for the Sphinx documentation builder."""
+
+# Reference: http://www.sphinx-doc.org/en/master/config
+
+# pylint: disable=invalid-name
+# because these variables are not named in upper case, as globals should be.
+
+project = "order_utils.py"
+# pylint: disable=redefined-builtin
+copyright = "2018, ZeroEx, Intl."
+author = "F. Eugene Aumson"
+version = "" # The short X.Y 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 = [] # type: ignore
+
+# 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 = "order_utilspydoc"
+
+# -- Extension configuration:
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {"https://docs.python.org/": None}