Merge pull request #26 from sphinx-contrib/domain

Wrap directives in minimal domain
sphinx-contrib · Jun 12, 2019 · 3bd6258 · 3bd6258
2 parents 4bde6ad + b7e21ed
commit 3bd6258
Show file tree

Hide file tree

Showing 10 changed files with 64 additions and 15 deletions.
diff --git a/doc/source/csv.rst b/doc/source/csv.rst
@@ -20,7 +20,7 @@ Code
 
 .. code-block:: rst
 
-    .. datatemplate-csv::
+    .. datatemplate:csv::
         :source: sample.csv
         :template: csv-sample.tmpl
         :headers:
@@ -29,7 +29,7 @@ Code
 Rendered Output
 ===============
 
-.. datatemplate-csv::
+.. datatemplate:csv::
     :source: sample.csv
     :template: csv-sample.tmpl
     :headers:

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -18,6 +18,7 @@ for Sphinx to render as part of its output.
    yaml
    csv
    xml
+   legacy
 
 Indices and tables
 ==================

diff --git a/doc/source/json.rst b/doc/source/json.rst
@@ -17,6 +17,6 @@ Template File
 Rendered Output
 ===============
 
-.. datatemplate-json::
+.. datatemplate:json::
    :source: sample.json
    :template: sample.tmpl
diff --git a/doc/source/legacy.rst b/doc/source/legacy.rst
@@ -0,0 +1,25 @@
+================
+ Legacy Samples
+================
+
+The ``datatemplate`` directive is should no longer be used. It is
+deprecated, and will be removed in the next release.
+
+Data File
+=========
+
+.. include:: sample.yaml
+   :literal:
+
+Template File
+=============
+
+.. include:: _templates/sample.tmpl
+   :literal:
+
+Rendered Output
+===============
+
+.. datatemplate::
+   :source: sample.yaml
+   :template: sample.tmpl
diff --git a/doc/source/using.rst b/doc/source/using.rst
@@ -5,7 +5,7 @@
 The ``datatemplate`` directive is the interface between the data
 source and the rendering template. It requires two parameters.
 
-.. rst:directive:: datatemplate-json
+.. rst:directive:: datatemplate:json
     
    Load ``source`` via :py:func:`json.load`
 
@@ -21,7 +21,7 @@ source and the rendering template. It requires two parameters.
 
         The text encoding that will be used to read the source file. See :any:`standard-encodings`
 
-.. rst:directive:: datatemplate-yaml
+.. rst:directive:: datatemplate:yaml
     
    Load ``source`` via PyYAML_ (``yaml.safe_load``)
 
@@ -39,7 +39,7 @@ source and the rendering template. It requires two parameters.
 
 .. _PyYAML: https://pyyaml.org
 
-.. rst:directive:: datatemplate-xml
+.. rst:directive:: datatemplate:xml
     
    Load ``source`` via :py:func:`xml.etree.ElementTree.parse` (actually using ``defusedxml``)
 
@@ -53,7 +53,7 @@ source and the rendering template. It requires two parameters.
         
 
 
-.. rst:directive:: datatemplate-csv
+.. rst:directive:: datatemplate:csv
     
    Load ``source`` via :py:func:`csv.reader` or :py:class:`csv.DictReader` depending on ``header``
 

diff --git a/doc/source/xml.rst b/doc/source/xml.rst
@@ -17,6 +17,6 @@ Template File
 Rendered Output
 ===============
 
-.. datatemplate-xml::
+.. datatemplate:xml::
    :source: sample.xml
    :template: xml-sample.tmpl
diff --git a/doc/source/yaml.rst b/doc/source/yaml.rst
@@ -17,6 +17,6 @@ Template File
 Rendered Output
 ===============
 
-.. datatemplate-yaml::
+.. datatemplate:yaml::
    :source: sample.yaml
    :template: sample.tmpl
diff --git a/sphinxcontrib/datatemplates/__init__.py b/sphinxcontrib/datatemplates/__init__.py
@@ -1,14 +1,16 @@
 from sphinx.util import logging
 
-from sphinxcontrib.datatemplates import directive
+from . import directive, domain
 
 LOG = logging.getLogger(__name__)
 
 
 def setup(app):
     LOG.info('initializing sphinxcontrib.datatemplates')
-    app.add_directive('datatemplate-json', directive.DataTemplateJSON)
-    app.add_directive('datatemplate-yaml', directive.DataTemplateYAML)
-    app.add_directive('datatemplate-csv', directive.DataTemplateCSV)
-    app.add_directive('datatemplate-xml', directive.DataTemplateXML)
     app.add_directive('datatemplate', directive.DataTemplateLegacy)
+    app.add_domain(domain.DataTemplateDomain)
+
+    return {
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }
diff --git a/sphinxcontrib/datatemplates/domain.py b/sphinxcontrib/datatemplates/domain.py
@@ -0,0 +1,21 @@
+from sphinx.domains import Domain
+from . import directive
+
+
+class DataTemplateDomain(Domain):
+
+    name = 'datatemplate'
+    label = 'DataTemplate Replacement'
+    directives = {
+        'json': directive.DataTemplateJSON,
+        'yaml': directive.DataTemplateYAML,
+        'csv': directive.DataTemplateCSV,
+        'xml': directive.DataTemplateXML,
+    }
+
+    def get_objects(self):
+        return []
+
+    def resolve_xref(self, env, fromdocname, builder, typ, target, node,
+                     contnode):
+        return None
diff --git a/tools/travis.sh b/tools/travis.sh
@@ -14,7 +14,7 @@ set -e
 
 case "$BUILD" in
     docs)
-        sphinx-build -W -b html doc/source doc/build;;
+        sphinx-build -b html doc/source doc/build;;
     linter)
         flake8 sphinxcontrib setup.py;
         python setup.py sdist;