diff --git a/USAGE.rst b/USAGE.rst index 21d29986..48e56a40 100644 --- a/USAGE.rst +++ b/USAGE.rst @@ -2,10 +2,12 @@ Usage ===== -Select the "Sphinx Wagtail theme" in the `conf.py` file of a Sphinx project:: +Select the "Sphinx Wagtail theme" in the ``conf.py`` file of a Sphinx project: + +.. code-block:: python # include the theme in the list of extensions to be loaded - extensions = ['sphinx_wagtail_theme', …] + extensions = ['sphinx_wagtail_theme', ...] # select the theme html_theme = 'sphinx_wagtail_theme' @@ -13,7 +15,9 @@ Select the "Sphinx Wagtail theme" in the `conf.py` file of a Sphinx project:: For developers: -The following snippet should always work if appended at the end of `conf.py`:: +The following snippet should always work if appended at the end of ``conf.py``: + +.. code-block:: python try: extensions diff --git a/docs/conf.py b/docs/conf.py index 4292e5ab..c68d2b21 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,7 @@ version = sphinx_wagtail_theme.__version__ # The full version, including alpha/beta/rc tags. release = sphinx_wagtail_theme.__version__ -language = None +language = "en" exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'requirements.txt'] # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False