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

Jump to bottom

DOCS: correct the option html_source_suffix to html_sourcelink_suffix #859

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

DOCS: correct the option html_source_suffix to html_sourcelink_suffix #859

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/components/download.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ html_theme_options = {
```

```{note}
This theme over-rides the Sphinx default for `html_source_suffix` to be `''` instead of `.txt`.
This theme over-rides the Sphinx default for `html_sourcelink_suffix` to be `''` instead of `.txt`.
This is because most users of this theme want to download source files of the pages themselves, which do not begin with `.txt`.
If you wish to add a different source suffix, manually specify `html_source_suffix` in `conf.py`.
If you wish to add a different source suffix, manually specify `html_sourcelink_suffix` in `conf.py`.
```