Skip to content

Commit 29bdc7a

Browse files
committed
fix: attempt to improve and get docs configs working
1 parent d63565c commit 29bdc7a

File tree

2 files changed

+48
-6
lines changed

2 files changed

+48
-6
lines changed

docs/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@
66

77

88
project = "cookiecutter-robust-python Template Documentation"
9-
copyright = f"{date.today().year}, Kyle Oliver"
9+
copyright = f"{date.today().year}, Kyle Oliver" # noqa
1010

11-
# Author name
1211
author = "Kyle Oliver"
1312

1413
release = "2025.04.28"

{{cookiecutter.project_name}}/docs/conf.py

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,55 @@
22

33
project = "{{cookiecutter.friendly_name}}"
44
author = "{{cookiecutter.author}}"
5-
copyright = "{{cookiecutter.copyright_year}}, {{cookiecutter.author}}" # noqa: A001
5+
copyright = "{{cookiecutter.copyright_year}}, {{cookiecutter.author}}" # noqa
6+
7+
release = "{{cookiecutter.version}}"
8+
version = ".".join("{{cookiecutter.version}}".split(".")[:2])
9+
610
extensions = [
7-
"sphinx.ext.autodoc",
11+
"sphinx.ext.intersphinx",
812
"sphinx.ext.napoleon",
9-
"sphinx_click",
1013
"myst_parser",
14+
"sphinx_autodoc_typehints",
15+
"sphinx_copybutton",
16+
"sphinx_tabs.tabs",
17+
]
18+
templates_path = ["_templates"]
19+
20+
exclude_patterns = [
21+
"_build",
22+
"Thumbs.db",
23+
".DS_Store",
24+
".venv",
25+
".nox",
26+
"rust",
27+
"tests",
28+
"cookiecutter.json",
29+
"README.md",
30+
"noxfile.py",
31+
".pre-commit-config.yaml",
32+
"pyproject.toml",
1133
]
12-
autodoc_typehints = "description"
34+
35+
myst_enable_extensions = [
36+
"amsmath",
37+
"colon_fence",
38+
"deflist",
39+
"dollarmath",
40+
"html_admonition",
41+
"html_image",
42+
"replacements",
43+
"smartquotes",
44+
"strikethrough",
45+
"substitution",
46+
"tasklist",
47+
"attrs_inline",
48+
"attrs_block",
49+
]
50+
51+
intersphinx_mapping = {
52+
"python": ("https://docs.python.org/3", None),
53+
"pip": ("https://pip.pypa.io/en/stable/", None),
54+
}
55+
1356
html_theme = "furo"

0 commit comments

Comments
 (0)