Skip to content

Commit 15cf9e3

Browse files
phinateclaude
andcommitted
feat: add MkDocs Material documentation scaffolding
- Add docs dependency group (mkdocs-material, mkdocstrings) - Add mkdocs.yml with Material theme config - Add placeholder docs/index.md and docs/reference.md - All docs files are conditional on include_docs copier variable Co-Authored-By: Claude Opus 4.6 <[email protected]>
1 parent b772fb8 commit 15cf9e3

4 files changed

Lines changed: 40 additions & 0 deletions

File tree

project_template/pyproject.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,12 @@ test = [
5050
lint = [
5151
"ruff>=0.15",
5252
]
53+
{%- if include_docs %}
54+
docs = [
55+
"mkdocs-material>=9.0",
56+
"mkdocstrings[python]>=0.27",
57+
]
58+
{%- endif %}
5359

5460
[project.urls]
5561
Homepage = "{{ url }}"
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# {{ project_name }}
2+
3+
{{ project_short_description }}
4+
5+
<!-- TODO: Add project overview, installation instructions, and quickstart guide. -->
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# API Reference
2+
3+
::: {{ python_name }}
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
site_name: "{{ project_name }}"
2+
site_url: "https://{{ org }}.github.io/{{ project_name }}"
3+
repo_url: "{{ url }}"
4+
5+
theme:
6+
name: material
7+
features:
8+
- content.code.copy
9+
- navigation.sections
10+
- search.highlight
11+
12+
plugins:
13+
- search
14+
- mkdocstrings:
15+
handlers:
16+
python:
17+
paths: [src]
18+
19+
nav:
20+
- Home: index.md
21+
- API Reference: reference.md
22+
23+
markdown_extensions:
24+
- admonition
25+
- pymdownx.highlight
26+
- pymdownx.superfences

0 commit comments

Comments
 (0)