Skip to content

Commit

Permalink
docs: document theme option for available languages
Browse files Browse the repository at this point in the history
  • Loading branch information
tillywoodfield committed Nov 12, 2024
1 parent 9e40ee9 commit 79c24f9
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ This theme has multiple options, which can be configured using the :code:`html_t
html_theme_options = {
"github_repository": "https://github.com/organisation/repository",
"header_title_text": "Title",
"languages": {
"en": "English",
},
"plausible_domain": "example.com"
}
Expand All @@ -52,6 +55,13 @@ This should be a link to the Github repository for the documentation site, and i

The site's title to display in the header and navigation.

:code:`languages`
-----------------

A dictionary of languages which the documentation is available in, used to populate the language switcher component.

For each entry, the keys (:code:`en`) is used to send the user to the correct site, and the value (:code:`English`) is displayed in the language switcher.

:code:`plausible_domain`
------------------------

Expand Down

0 comments on commit 79c24f9

Please sign in to comment.