Skip to content

Commit 47f705e

Browse files
tschmclaude
andcommitted
Docs: add mkdocs.yml and fix book target when mkdocs is skipped
- Add mkdocs.yml with Material theme, mermaid support, and full nav covering root-level docs and docs/ directory - Fix book.mk to mkdir -p before touch .nojekyll so the target does not fail when mkdocs.yml is absent and _book/ was never created Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent cf1bcc5 commit 47f705e

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed

.rhiza/make.d/book.mk

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ _book-notebooks:
5858

5959
book:: _book-reports _book-notebooks ## compile the companion book via MkDocs
6060
@$(MAKE) mkdocs-build MKDOCS_OUTPUT=$(BOOK_OUTPUT)
61+
@mkdir -p "$(BOOK_OUTPUT)"
6162
@touch "$(BOOK_OUTPUT)/.nojekyll"
6263
@printf "${GREEN}[SUCCESS] Book built at $(BOOK_OUTPUT)/${RESET}\n"
6364
@tree $(BOOK_OUTPUT)

mkdocs.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
site_name: Rhiza CLI
2+
site_description: Reusable configuration templates for modern Python projects
3+
site_url: https://jebel-quant.github.io/rhiza-cli/
4+
repo_url: https://github.com/jebel-quant/rhiza-cli
5+
repo_name: jebel-quant/rhiza-cli
6+
edit_uri: edit/main/
7+
8+
docs_dir: .
9+
10+
theme:
11+
name: material
12+
palette:
13+
- scheme: default
14+
primary: teal
15+
accent: teal
16+
toggle:
17+
icon: material/brightness-7
18+
name: Switch to dark mode
19+
- scheme: slate
20+
primary: teal
21+
accent: teal
22+
toggle:
23+
icon: material/brightness-4
24+
name: Switch to light mode
25+
features:
26+
- navigation.tabs
27+
- navigation.sections
28+
- navigation.expand
29+
- toc.integrate
30+
- search.suggest
31+
- search.highlight
32+
- content.code.copy
33+
34+
markdown_extensions:
35+
- admonition
36+
- attr_list
37+
- toc:
38+
permalink: true
39+
- pymdownx.details
40+
- pymdownx.highlight:
41+
anchor_linenums: true
42+
- pymdownx.superfences:
43+
custom_fences:
44+
- name: mermaid
45+
class: mermaid
46+
format: !!python/name:pymdownx.superfences.fence_code_format
47+
- pymdownx.tabbed:
48+
alternate_style: true
49+
50+
nav:
51+
- Home: README.md
52+
- Getting Started: GETTING_STARTED.md
53+
- CLI Reference: CLI.md
54+
- Usage Guide: USAGE.md
55+
- Guides:
56+
- Architecture: docs/ARCHITECTURE.md
57+
- Authentication: docs/AUTHENTICATION.md
58+
- Customization: docs/CUSTOMIZATION.md
59+
- Testing: docs/TESTS.md
60+
- Quick Reference: docs/QUICK_REFERENCE.md
61+
- Reference:
62+
- Glossary: docs/GLOSSARY.md
63+
- Security: docs/SECURITY.md
64+
- Demo: docs/DEMO.md
65+
- Decisions:
66+
- Overview: docs/adr/README.md
67+
- ADR-0001 — Inline get_diff: docs/adr/0001-inline-get-diff-instead-of-cruft.md
68+
- ADR-0002 — Repository/ref keys: docs/adr/0002-repository-ref-as-canonical-keys.md
69+
- ADR-0003 — Lock file concurrency: docs/adr/0003-lock-file-concurrency.md

0 commit comments

Comments
 (0)