Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 9 additions & 11 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2
Expand All @@ -10,13 +9,12 @@ build:
os: ubuntu-24.04
tools:
python: '3.13'

mkdocs:
configuration: mkdocs.yml

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt

formats: all
jobs:
install:
- pip install -r docs/requirements.txt
build:
html:
- zensical build
post_build:
- mkdir -p $READTHEDOCS_OUTPUT/html/
- cp --recursive site/* $READTHEDOCS_OUTPUT/html/
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
jinja2
python-markdown-math
mkdocs
zensical
mkdocs-material
8 changes: 8 additions & 0 deletions docs/css/extra.css → docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
[data-md-color-primary='custom'] {
--md-primary-fg-color: #ff3166;
--md-primary-fg-color--light: #ff3166;
--md-primary-fg-color--dark: #ff3166;
--md-primary-bg-color: #fff;
--md-primary-bg-color--light: #ffffffb3;
}

@media screen and (max-width: 768px) {
img {
width: auto;
Expand Down
4 changes: 2 additions & 2 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -161,12 +161,12 @@ python-test:
# Serve documentation locally
[group('Documentation')]
docs:
uv run mkdocs serve
uv run zensical serve

# Build documentation
[group('Documentation')]
docs-build:
uv run mkdocs build
uv run zensical build

# Install pre-commit hooks
[group('Pre-commit & CI')]
Expand Down
89 changes: 0 additions & 89 deletions mkdocs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ dependencies = [
[dependency-groups]
dev = [
"mkdocs-material>=9.5.49",
"mkdocs>=1.6.1",
"ipykernel>=6.29.5",
"pytest>=8.3.4",
"pytest-cov>=6.0.0",
"pre-commit>=4.2.0",
"ty==0.0.16",
"ruff>=0.15.1",
"zensical>=0.0.24",
]

[project.optional-dependencies]
Expand Down
47 changes: 42 additions & 5 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

93 changes: 93 additions & 0 deletions zensical.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
[project]
site_name = "CocktailBerry: Open Source Cocktail Machine Software"
site_description = "Official CocktailBerry Documentation: Open Source Software to easily build your own automated cocktail machine."
site_author = "Andre Wohnsland"
copyright = "© Copyright 2026, Andre Wohnsland & contributors"
repo_url = "https://github.com/AndreWohnsland/CocktailBerry"
repo_name = "GitHub Cocktailberry"

nav = [
{ "Home" = "index.md" },
{ "About" = "about.md" },
{ "Quickstart" = "quickstart.md" },
{ "Installation" = "installation.md" },
{ "Hardware" = "hardware.md" },
{ "Setup / Usage" = "setup.md" },
{ "CocktailBerry Web" = "web.md" },
{ "Supported Languages" = "languages.md" },
{ "CLI commands" = "commands.md" },
{ "Payment Feature" = "payment.md" },
{ "Service Personnel" = "waiter.md" },
{ "Advanced Topics" = "advanced.md" },
{ "Addons" = "addons.md" },
{ "Troubleshooting" = "troubleshooting.md" },
{ "FAQ" = "faq.md" },
{ "Feature Timetable" = "features.md" },
{ "Development" = "development.md" },
{ "How to Support" = "support.md" },
]

extra_css = ["stylesheets/extra.css"]

[project.theme]
variant = "classic"
custom_dir = "docs/overrides"
logo = "img/berry.svg"
favicon = "img/favicon.ico"
features = [
"navigation.footer",
"content.code.copy",
"content.code.annotate",
"announce.dismiss",
"content.tabs.link",
]

[[project.theme.palette]]
scheme = "default"
primary = "custom"
toggle.icon = "material/weather-sunny"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
scheme = "slate"
primary = "custom"
toggle.icon = "material/weather-night"
toggle.name = "Switch to light mode"

# Since we customize superfences and tabbed, we must explicitly define all extensions
# https://zensical.org/docs/setup/extensions/#default-configuration-zensicaltoml
[project.markdown_extensions.abbr]
[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.def_list]
[project.markdown_extensions.footnotes]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.toc]
permalink = "#"
[project.markdown_extensions.pymdownx.arithmatex]
generic = true
[project.markdown_extensions.pymdownx.betterem]
smart_enable = "all"
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg"
[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.keys]
[project.markdown_extensions.pymdownx.mark]
[project.markdown_extensions.pymdownx.smartsymbols]
[project.markdown_extensions.pymdownx.snippets]
[project.markdown_extensions.pymdownx.superfences]
custom_fences = [
{ name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
combine_header_slug = true
slugify = { function = "pymdownx.slugs.slugify", kwds = { case = "lower" } }
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
[project.markdown_extensions.pymdownx.tilde]