Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set language to English for our own docs #192

Merged
merged 2 commits into from
Aug 18, 2022
Merged

Set language to English for our own docs #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71f10e3
Set language to English for our own docs
vsalvino Aug 17, 2022
c7021eb
Fix syntax error in python code block
vsalvino Aug 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions USAGE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,22 @@
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'


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
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down