integrating jsonschema2rst documentation

inspirehep · Apr 27, 2017 · 3bd5d90 · 3bd5d90
1 parent 6c17361
commit 3bd5d90
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -27,8 +27,20 @@
 import os
 
 from autosemver.packaging import get_changelog, get_current_version
+from jsonschema2rst.parser_runner import run_parser
 
 
+def _generate_schemas_doc():
+    schemas_folder = os.path.join(
+        os.pardir,
+        'inspire_schemas/records'
+    )
+    rst_output = 'documentation'
+    run_parser(schemas_folder, rst_output)
+
+
+_generate_schemas_doc()
+
 if not os.path.exists('_build/html/_static'):
     os.makedirs('_build/html/_static')
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -59,6 +59,18 @@ this part of the documentation is for you.
    api
    utils
 
+
+Schemas Reference
+-------------
+
+Auto-generated documentation for Inspirehep schemas.
+
+.. toctree::
+   :maxdepth: 2
+
+   documentation/index
+
+
 Additional Notes
 ----------------
 

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -1,2 +1,3 @@
+jsonschema2rst
 Sphinx>=1.4.2
 -r requirements-build.txt