diff options
author | F. Eugene Aumson <feuGeneA@users.noreply.github.com> | 2019-01-09 03:28:32 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-01-09 03:28:32 +0800 |
commit | 4689f20b86333d74fa0ccd45b23c560a0a0361b5 (patch) | |
tree | 9b1810a912a7c866d6be3799b24feea9c9f49d1f /python-packages/json_schemas/src/conf.py | |
parent | de927d7207571e99a009320d9a47ae9815c2e198 (diff) | |
parent | e62e61bf7145c0a8011e098aa22168416d01a781 (diff) | |
download | dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.gz dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.bz2 dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.lz dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.xz dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.zst dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.zip |
Move json_schemas to its own package (#1435)
* Move zero_ex.json_schemas to its own package
* Support ALL the schemas
* Stop installing packages as editable
* HACK: cp files because CircleCI isn't
* Add example usage to sra_client README
* Tweak special case: only strip Schema as suffix
* Correct doc titles
* Clarify what kind of support ticket was raised.
* Correct inconsistencies in JSON schema names
In both ref ID's and file names.
* Add entry point for validation of JSON strings
Diffstat (limited to 'python-packages/json_schemas/src/conf.py')
-rw-r--r-- | python-packages/json_schemas/src/conf.py | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/python-packages/json_schemas/src/conf.py b/python-packages/json_schemas/src/conf.py new file mode 100644 index 000000000..1ae1493e3 --- /dev/null +++ b/python-packages/json_schemas/src/conf.py @@ -0,0 +1,54 @@ +"""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-json-schemas" +# pylint: disable=redefined-builtin +copyright = "2018, ZeroEx, Intl." +author = "F. Eugene Aumson" +version = pkg_resources.get_distribution("0x-json-schemas").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 = "json_schemaspydoc" + +# -- Extension configuration: + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {"https://docs.python.org/": None} |