Skip to content

Configure the GitHub link in yardang's own docs #166

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

Merged
timkpaine merged 1 commit into from
Oct 17, 2026
Merged

Configure the GitHub link in yardang's own docs #166

Show file tree
Hide file tree
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
14 changes: 7 additions & 7 deletions docs/src/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,9 @@ for the full option list; the common ones are below.
[tool.yardang]
theme = "fuma"

[tool.yardang.sphinx]
html_theme_options = { github_url = "https://github.com/you/project", toc_style = "clerk" }
[tool.yardang.html_theme_options]
github_url = "https://github.com/you/project"
toc_style = "clerk"
```

| Option | Default | Description |
Expand Down Expand Up @@ -188,15 +189,15 @@ the active sidebar entry, the table-of-contents highlight and its rail. `amber`
is the grey-and-yellow pairing used on fumadocs' own site.

```toml
[tool.yardang.sphinx.html_theme_options]
[tool.yardang.html_theme_options]
color_preset = "amber"
```

Anything in `light_css_variables` / `dark_css_variables` overrides the preset,
so you can start from one and adjust:

```toml
[tool.yardang.sphinx.html_theme_options]
[tool.yardang.html_theme_options]
color_preset = "amber"
dark_css_variables = { "color-fd-background" = "#0a0a0a" }
```
Expand Down Expand Up @@ -238,7 +239,7 @@ a docname prefix used to decide which entry is current; it defaults to the
directory part of `url`.

```toml
[[tool.yardang.sphinx.html_theme_options.sidebar_tabs]]
[[tool.yardang.html_theme_options.sidebar_tabs]]
title = "Guides"
url = "guides/index.html"
description = "Get up and running"
Expand All @@ -258,8 +259,7 @@ use-search = false
```

The `fuma` theme renders the results in its own dialog; every other theme gets
the one `sphinx-searchlite` ships. Options such as `searchlite_index_filename`
pass through `[tool.yardang.sphinx]` as normal.
the one `sphinx-searchlite` ships.

## `custom-css` / `custom-js`

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@ pages = [
]
use-autoapi = false
html_extra_path = ["docs/examples"]
html_theme_options = { github_url = "https://github.com/python-project-templates/yardang" }

[tool.yardang.breathe]
projects = { calculator = "examples/cpp/xml" }
Expand Down