Merge pull request #7 from adamtheturtle/type-list

Change type of `substitution` to `List`

.travis.yml

@@ -12,6 +12,7 @@ install:
 cache: pip
 script:
 - make lint
+- make sample
 - pytest -s -vvv --cov=src/ --cov=tests tests/
 after_success:
 - codecov

CHANGELOG.rst

@@ -6,6 +6,8 @@ Changelog
 Next
 ----
 
+- Make ``substitution`` a list, not a tuple.
+
 2018.11.12.2
 ------------
 

Makefile

@@ -32,5 +32,5 @@ fix-lint:
 
 .PHONY: sample
 sample:
-	sphinx-build -b html sample/source sample/build
+	sphinx-build -W -b html sample/source sample/build
 	python -c 'import os, webbrowser; webbrowser.open("file://" + os.path.abspath("sample/build/contents.html"))'

README.rst

@@ -29,10 +29,10 @@ Setup
 
 .. code:: python
 
-   substitutions = (
+   substitutions = [
        ('|release|', '0.1'),
        ('|author|', 'Eleanor'),
-   )
+   ]
 
 This will replace ``|release|`` in the new directives with ``0.1``, and ``|author|`` with ``Eleanor``.
 

sample/source/conf.py

@@ -4,4 +4,4 @@
 ]
 
 _substitution_pair = ('|author|', 'Eleanor')
-substitutions = (_substitution_pair, )
+substitutions = [_substitution_pair]

src/sphinx_substitution_extensions/__init__.py

@@ -66,6 +66,6 @@ def setup(app: Sphinx) -> None:
     """
     Add the custom directives to Sphinx.
     """
-    app.add_config_value('substitutions', (), 'html')
+    app.add_config_value('substitutions', [], 'html')
     app.add_directive('substitution-prompt', SubstitutionPrompt)
     app.add_directive('substitution-code-block', SubstitutionCodeBlock)

tests/test_substitution_extensions.py

@@ -22,9 +22,9 @@ def test_substitution_prompt(tmpdir: local) -> None:
     conf_py_content = dedent(
         """\
         extensions = ['sphinx_substitution_extensions']
-        substitutions = (
+        substitutions = [
             ('|a|', 'example_substitution'),
-        )
+        ]
         """,
     )
     conf_py.write(conf_py_content)
@@ -66,9 +66,9 @@ def test_substitution_code_block(tmpdir: local) -> None:
     conf_py_content = dedent(
         """\
         extensions = ['sphinx_substitution_extensions']
-        substitutions = (
+        substitutions = [
             ('|a|', 'example_substitution'),
-        )
+        ]
         """,
     )
     conf_py.write(conf_py_content)