lizardbyte-dockle 2026.919.233535__tar.gz

lizardbyte_dockle-2026.919.233535/.gitignore

@@ -0,0 +1,33 @@
+# JetBrains IDEs
+.idea/
+
+# Dockle
+.dockle/
+_site/
+
+# Node.js
+.npm-cache/
+.npm-tmp/
+node_modules/
+
+# Generated from pinned Node.js dependencies
+src/dockle/sphinx/themes/dockle/static/HIGHLIGHT_LICENSE.txt
+src/dockle/sphinx/themes/dockle/static/LUCIDE_LICENSE.txt
+src/dockle/sphinx/themes/dockle/static/highlight.min.js
+src/dockle/sphinx/themes/dockle/static/lucide.min.js
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+build/
+dist/
+
+# Test and tooling caches
+.coverage
+coverage/
+junit-python.xml
+junit.xml
+.pytest_cache/
+.ruff_cache/

lizardbyte_dockle-2026.919.233535/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 LizardByte LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lizardbyte_dockle-2026.919.233535/PKG-INFO

@@ -0,0 +1,254 @@
+Metadata-Version: 2.5
+Name: lizardbyte-dockle
+Version: 2026.919.233535
+Summary: Build documentation with multiple frameworks and one consistent theme.
+Project-URL: Documentation, https://dockle.readthedocs.io/
+Project-URL: Issues, https://github.com/LizardByte/dockle/issues
+Project-URL: Repository, https://github.com/LizardByte/dockle
+Author: LizardByte
+License-Expression: MIT
+License-File: LICENSE
+Keywords: documentation,doxygen,jsdoc,mkdocs,rustdoc,sphinx
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Documentation
+Requires-Python: >=3.11
+Requires-Dist: markdown>=3.8
+Provides-Extra: all
+Requires-Dist: mkdocs>=1.6; extra == 'all'
+Requires-Dist: myst-parser>=4.0; extra == 'all'
+Requires-Dist: sphinx>=8.1; extra == 'all'
+Provides-Extra: mkdocs
+Requires-Dist: mkdocs>=1.6; extra == 'mkdocs'
+Provides-Extra: sphinx
+Requires-Dist: myst-parser>=4.0; extra == 'sphinx'
+Requires-Dist: sphinx>=8.1; extra == 'sphinx'
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img
+    src="/branding/dockle-logo.svg"
+    alt="Dockle logo"
+    width="192"
+  />
+  <h1 align="center">Dockle</h1>
+  <h4 align="center">Build documentation with multiple frameworks and one consistent theme.</h4>
+</div>
+
+<div align="center">
+  <a href="https://github.com/LizardByte/dockle"><img src="https://img.shields.io/github/stars/lizardbyte/dockle.svg?logo=github&style=for-the-badge" alt="GitHub stars"></a>
+  <a href="https://codecov.io/gh/LizardByte/dockle"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fapp.lizardbyte.dev%2Fdashboard%2Fshields%2Fcodecov%2Fdockle.json&style=for-the-badge&logo=codecov" alt="Codecov"></a>
+  <a href="https://sonarcloud.io/project/overview?id=LizardByte_dockle"><img src="https://img.shields.io/sonar/quality_gate/LizardByte_dockle?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=sonarcloud" alt="SonarCloud"></a>
+</div>
+
+Dockle is a configuration and presentation layer for documentation generators. A project describes itself once in
+`dockle.toml`; Dockle translates that model into temporary Sphinx, Doxygen, MkDocs, JSDoc, or rustdoc configuration,
+runs the underlying tool, and applies its own shared, Furo-inspired visual layer to the generated HTML. A full build
+publishes a configured home target directly, adding a landing page only when a project needs one.
+
+Any framework can own the root, with cards to other published targets injected
+when needed. Project assets and metadata are configured once and then applied
+to every generated documentation set. Redirect-only compatibility aliases under
+the home target's name preserve existing target-prefixed deep links without
+restoring a separate landing page.
+
+The Sphinx integration is a first-party `dockle` theme. Furo is a design reference, not a runtime dependency or base
+theme.
+
+## Why Dockle?
+
+- Keep framework-specific configuration out of consumer repositories.
+- Build one or several documentation targets from one command.
+- Give prose and API references the same colors, typography, spacing, code blocks, tables, and responsive behavior.
+- Keep the generators replaceable: Dockle orchestrates them rather than attempting to parse every source format itself.
+
+## Quick start
+
+Dockle requires Python 3.11 or newer. Install the adapters needed by the project:
+
+```shell
+python -m pip install "lizardbyte-dockle[sphinx,mkdocs]"
+```
+
+The PyPI distribution uses the organization-qualified name `lizardbyte-dockle`; the project, Python package, and
+command remain `dockle`. Doxygen, JSDoc, and the Rust toolchain remain native tool dependencies. Their executable paths
+can be overridden in `dockle.toml` when they are not available on `PATH`.
+
+JavaScript-only projects can use the native Dockle JSDoc template without Python, Doxygen, or Graphviz:
+
+```shell
+npm install --save-dev @lizardbyte/dockle
+npx dockle-jsdoc src --destination docs
+```
+
+That npm package includes JSDoc and the first-party template. The Python package uses the same template when JSDoc is
+one target in a larger multi-framework site.
+
+Create a single configuration file:
+
+```toml
+[project]
+name = "Example"
+version = "1.0.0"
+description = "Example project documentation"
+repository = "https://github.com/example/example"
+logo = "branding/logo.png"
+
+[theme]
+primary = "#2962ff"
+content = "#2e3440"
+light_background = "#ffffff"
+dark_background = "#131416"
+
+[build]
+output = "_site"
+work = ".dockle"
+strict = true
+
+[[targets]]
+name = "docs"
+title = "Project documentation"
+framework = "sphinx"
+source = "docs"
+home = true
+
+[[targets]]
+name = "cpp-api"
+framework = "doxygen"
+source = "."
+
+[targets.doxygen]
+inputs = ["README.md", "docs", "src"]
+main_page = "README.md"
+predefined = ["EXAMPLE_PUBLIC_API=1"]
+
+[[targets]]
+name = "rust-api"
+framework = "rustdoc"
+source = "."
+
+[[targets]]
+name = "web-api"
+framework = "jsdoc"
+source = "src"
+
+[targets.jsdoc]
+readme = "README.md"
+```
+
+Then inspect or run the build:
+
+```shell
+dockle build --dry-run
+dockle check
+dockle build
+dockle build manual cpp-api
+```
+
+The configuration path can be changed with `dockle --config path/to/dockle.toml build`. A complete build cleans the
+whole output tree so removed targets cannot leave stale pages behind; a named-target build only replaces that target.
+Strict mode is opt-in for consumers; set `strict = true` when warnings should fail the build. Doxygen's individual
+documentation warning switches remain enabled by default. A Sphinx target can set `extra_config` to a Python fragment
+that Dockle executes after its generated `conf.py`, and a Doxygen target can set `generate_xml = true` and
+`publish = false` when an extension such as Breathe needs XML without a separate public API site. On Read the Docs,
+Dockle derives the displayed version from `READTHEDOCS_VERSION` and preserves the configured width of all-zero versions
+for numeric pull-request builds.
+
+## Review all five adapters
+
+This repository is also an executable comparison suite. Every adapter has an
+overview, component reference, GitHub-style alerts, code, tables, and an API or
+reference page. Each language fixture differs only where the underlying
+generator requires it:
+
+```shell
+python -m pip install -e ".[all]"
+npm ci --ignore-scripts
+npm run build
+dockle check
+dockle build
+```
+
+Doxygen and Cargo must be installed separately. The JSDoc adapter finds a project-local executable in
+`node_modules/.bin`, so a global Node.js package is not required. Open `_site/index.html` to move between the generated
+Sphinx, Doxygen, MkDocs, JSDoc, and rustdoc sites.
+
+## Read the Docs
+
+The root `.readthedocs.yaml` delegates to `readthedocs_build.sh` because Dockle, rather than Read the Docs, owns generator
+selection. Consumers call the same script from a `third-party/dockle` checkout. A fully pinned conda environment supplies
+Doxygen, Graphviz, and Python while Read the Docs supplies Node.js and Rust. The script creates that environment, installs
+the hosted prerequisites, runs Dockle through `conda run`, and copies the complete portal to
+`$READTHEDOCS_OUTPUT/html/`. Optional project hooks named `readthedocs_pre_build.sh` and
+`readthedocs_post_build.sh` run immediately before and after Dockle.
+
+No Sphinx or MkDocs configuration is duplicated for the hosting service. Once this repository is imported into Read
+the Docs, each branch and pull request build will exercise the root Sphinx documentation and all five adapters used
+locally.
+
+## Distribution
+
+The Python package is the canonical multi-framework orchestrator. PyPI provides the normal install path, while
+standalone per-platform executables make that command available to C++, JavaScript, and Rust projects without requiring
+a managed Python environment. The `@lizardbyte/dockle` npm package is intentionally narrower: it provides JSDoc, the
+native Dockle JSDoc template, and the `dockle-jsdoc` command without installing Python or unrelated documentation
+toolchains. A crates.io package still only makes sense if it provides comparable installation value or a real Rust API
+rather than a second implementation.
+
+For CMake projects, [`cmake/Dockle.cmake`](cmake/Dockle.cmake) already exposes `dockle_add_docs()`. It finds an installed
+or standalone Dockle command and falls back to `Python3 -m dockle`.
+
+## Adapter status
+
+| Framework | Configuration generated by Dockle | Shared theme path | Initial adapter |
+| --- | --- | --- | --- |
+| Sphinx | `conf.py` | Dockle's packaged Sphinx theme | Implemented |
+| Doxygen | `Doxyfile` | `HTML_EXTRA_STYLESHEET` | Implemented |
+| MkDocs | `mkdocs.yml` | Dockle's packaged MkDocs theme | Implemented |
+| JSDoc | `jsdoc.json` | Dockle's packaged native JSDoc template | Implemented |
+| rustdoc | Cargo command and environment | Generated HTML normalization | Implemented |
+
+Every adapter now receives Dockle's generated client-side search index and the
+same search interface, including result ranking and empty/error behavior. The
+color-scheme control sits beside search and uses a state-aware Lucide icon.
+Sphinx, MkDocs, and JSDoc use first-party templates. Doxygen and rustdoc keep
+their semantic output while Dockle normalizes their structure and visual
+primitives. Doxygen additionally receives a persistent tree, an automatically
+completed page outline, and generated previous/next navigation.
+
+Authored code blocks are re-highlighted with Dockle's pinned Highlight.js
+runtime after each framework renders them, so native Pygments, Prettify,
+Doxygen, and rustdoc token markup cannot produce different results. Dockle
+normalizes common language aliases before highlighting; use `shell` for
+commands and scripts, and reserve `console` for transcripts that include a
+prompt or command output. Line-numbered native source listings retain their
+generator-provided navigation.
+
+Markdown GitHub alerts are enabled through MyST for Sphinx, a
+Dockle Markdown extension for MkDocs and the root portal, Doxygen's native
+parser, and a shared post-render enhancement for JSDoc and rustdoc. Dockle
+extends the same syntax with attention, danger, error, hint, see-also, and todo
+alerts. Its generated Doxyfile also supplies matching Doxygen aliases for
+admonition types that Doxygen does not provide itself. Portable tab sets use
+semantic `details` markup and are upgraded by Dockle's self-contained client
+script with keyboard navigation. An optional `data-dockle-tab-group` name links
+matching selections across tab sets and pages. Doxygen receives equivalent
+`@tab`, `@tabs`, and `@tabs_grouped` aliases without depending on
+`doxygen-awesome-css` or `doxyconfig`.
+
+## Development
+
+The centralized common-lint workflow handles repository linting on pull
+requests. Install the locked Python dependencies and run the test suite:
+
+```shell
+uv sync --locked --all-extras
+$env:PYTHONPATH = "src"  # PowerShell
+python -m unittest discover -s tests -v
+python -m compileall -q src tests
+```
+
+The root documentation is built from [docs/index.rst](docs/index.rst) with the
+same first-party Sphinx theme used by the example. The Sphinx fixture includes
+both MyST Markdown and reStructuredText component references.

lizardbyte_dockle-2026.919.233535/README.md

@@ -0,0 +1,226 @@
+<div align="center">
+  <img
+    src="/branding/dockle-logo.svg"
+    alt="Dockle logo"
+    width="192"
+  />
+  <h1 align="center">Dockle</h1>
+  <h4 align="center">Build documentation with multiple frameworks and one consistent theme.</h4>
+</div>
+
+<div align="center">
+  <a href="https://github.com/LizardByte/dockle"><img src="https://img.shields.io/github/stars/lizardbyte/dockle.svg?logo=github&style=for-the-badge" alt="GitHub stars"></a>
+  <a href="https://codecov.io/gh/LizardByte/dockle"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fapp.lizardbyte.dev%2Fdashboard%2Fshields%2Fcodecov%2Fdockle.json&style=for-the-badge&logo=codecov" alt="Codecov"></a>
+  <a href="https://sonarcloud.io/project/overview?id=LizardByte_dockle"><img src="https://img.shields.io/sonar/quality_gate/LizardByte_dockle?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=sonarcloud" alt="SonarCloud"></a>
+</div>
+
+Dockle is a configuration and presentation layer for documentation generators. A project describes itself once in
+`dockle.toml`; Dockle translates that model into temporary Sphinx, Doxygen, MkDocs, JSDoc, or rustdoc configuration,
+runs the underlying tool, and applies its own shared, Furo-inspired visual layer to the generated HTML. A full build
+publishes a configured home target directly, adding a landing page only when a project needs one.
+
+Any framework can own the root, with cards to other published targets injected
+when needed. Project assets and metadata are configured once and then applied
+to every generated documentation set. Redirect-only compatibility aliases under
+the home target's name preserve existing target-prefixed deep links without
+restoring a separate landing page.
+
+The Sphinx integration is a first-party `dockle` theme. Furo is a design reference, not a runtime dependency or base
+theme.
+
+## Why Dockle?
+
+- Keep framework-specific configuration out of consumer repositories.
+- Build one or several documentation targets from one command.
+- Give prose and API references the same colors, typography, spacing, code blocks, tables, and responsive behavior.
+- Keep the generators replaceable: Dockle orchestrates them rather than attempting to parse every source format itself.
+
+## Quick start
+
+Dockle requires Python 3.11 or newer. Install the adapters needed by the project:
+
+```shell
+python -m pip install "lizardbyte-dockle[sphinx,mkdocs]"
+```
+
+The PyPI distribution uses the organization-qualified name `lizardbyte-dockle`; the project, Python package, and
+command remain `dockle`. Doxygen, JSDoc, and the Rust toolchain remain native tool dependencies. Their executable paths
+can be overridden in `dockle.toml` when they are not available on `PATH`.
+
+JavaScript-only projects can use the native Dockle JSDoc template without Python, Doxygen, or Graphviz:
+
+```shell
+npm install --save-dev @lizardbyte/dockle
+npx dockle-jsdoc src --destination docs
+```
+
+That npm package includes JSDoc and the first-party template. The Python package uses the same template when JSDoc is
+one target in a larger multi-framework site.
+
+Create a single configuration file:
+
+```toml
+[project]
+name = "Example"
+version = "1.0.0"
+description = "Example project documentation"
+repository = "https://github.com/example/example"
+logo = "branding/logo.png"
+
+[theme]
+primary = "#2962ff"
+content = "#2e3440"
+light_background = "#ffffff"
+dark_background = "#131416"
+
+[build]
+output = "_site"
+work = ".dockle"
+strict = true
+
+[[targets]]
+name = "docs"
+title = "Project documentation"
+framework = "sphinx"
+source = "docs"
+home = true
+
+[[targets]]
+name = "cpp-api"
+framework = "doxygen"
+source = "."
+
+[targets.doxygen]
+inputs = ["README.md", "docs", "src"]
+main_page = "README.md"
+predefined = ["EXAMPLE_PUBLIC_API=1"]
+
+[[targets]]
+name = "rust-api"
+framework = "rustdoc"
+source = "."
+
+[[targets]]
+name = "web-api"
+framework = "jsdoc"
+source = "src"
+
+[targets.jsdoc]
+readme = "README.md"
+```
+
+Then inspect or run the build:
+
+```shell
+dockle build --dry-run
+dockle check
+dockle build
+dockle build manual cpp-api
+```
+
+The configuration path can be changed with `dockle --config path/to/dockle.toml build`. A complete build cleans the
+whole output tree so removed targets cannot leave stale pages behind; a named-target build only replaces that target.
+Strict mode is opt-in for consumers; set `strict = true` when warnings should fail the build. Doxygen's individual
+documentation warning switches remain enabled by default. A Sphinx target can set `extra_config` to a Python fragment
+that Dockle executes after its generated `conf.py`, and a Doxygen target can set `generate_xml = true` and
+`publish = false` when an extension such as Breathe needs XML without a separate public API site. On Read the Docs,
+Dockle derives the displayed version from `READTHEDOCS_VERSION` and preserves the configured width of all-zero versions
+for numeric pull-request builds.
+
+## Review all five adapters
+
+This repository is also an executable comparison suite. Every adapter has an
+overview, component reference, GitHub-style alerts, code, tables, and an API or
+reference page. Each language fixture differs only where the underlying
+generator requires it:
+
+```shell
+python -m pip install -e ".[all]"
+npm ci --ignore-scripts
+npm run build
+dockle check
+dockle build
+```
+
+Doxygen and Cargo must be installed separately. The JSDoc adapter finds a project-local executable in
+`node_modules/.bin`, so a global Node.js package is not required. Open `_site/index.html` to move between the generated
+Sphinx, Doxygen, MkDocs, JSDoc, and rustdoc sites.
+
+## Read the Docs
+
+The root `.readthedocs.yaml` delegates to `readthedocs_build.sh` because Dockle, rather than Read the Docs, owns generator
+selection. Consumers call the same script from a `third-party/dockle` checkout. A fully pinned conda environment supplies
+Doxygen, Graphviz, and Python while Read the Docs supplies Node.js and Rust. The script creates that environment, installs
+the hosted prerequisites, runs Dockle through `conda run`, and copies the complete portal to
+`$READTHEDOCS_OUTPUT/html/`. Optional project hooks named `readthedocs_pre_build.sh` and
+`readthedocs_post_build.sh` run immediately before and after Dockle.
+
+No Sphinx or MkDocs configuration is duplicated for the hosting service. Once this repository is imported into Read
+the Docs, each branch and pull request build will exercise the root Sphinx documentation and all five adapters used
+locally.
+
+## Distribution
+
+The Python package is the canonical multi-framework orchestrator. PyPI provides the normal install path, while
+standalone per-platform executables make that command available to C++, JavaScript, and Rust projects without requiring
+a managed Python environment. The `@lizardbyte/dockle` npm package is intentionally narrower: it provides JSDoc, the
+native Dockle JSDoc template, and the `dockle-jsdoc` command without installing Python or unrelated documentation
+toolchains. A crates.io package still only makes sense if it provides comparable installation value or a real Rust API
+rather than a second implementation.
+
+For CMake projects, [`cmake/Dockle.cmake`](cmake/Dockle.cmake) already exposes `dockle_add_docs()`. It finds an installed
+or standalone Dockle command and falls back to `Python3 -m dockle`.
+
+## Adapter status
+
+| Framework | Configuration generated by Dockle | Shared theme path | Initial adapter |
+| --- | --- | --- | --- |
+| Sphinx | `conf.py` | Dockle's packaged Sphinx theme | Implemented |
+| Doxygen | `Doxyfile` | `HTML_EXTRA_STYLESHEET` | Implemented |
+| MkDocs | `mkdocs.yml` | Dockle's packaged MkDocs theme | Implemented |
+| JSDoc | `jsdoc.json` | Dockle's packaged native JSDoc template | Implemented |
+| rustdoc | Cargo command and environment | Generated HTML normalization | Implemented |
+
+Every adapter now receives Dockle's generated client-side search index and the
+same search interface, including result ranking and empty/error behavior. The
+color-scheme control sits beside search and uses a state-aware Lucide icon.
+Sphinx, MkDocs, and JSDoc use first-party templates. Doxygen and rustdoc keep
+their semantic output while Dockle normalizes their structure and visual
+primitives. Doxygen additionally receives a persistent tree, an automatically
+completed page outline, and generated previous/next navigation.
+
+Authored code blocks are re-highlighted with Dockle's pinned Highlight.js
+runtime after each framework renders them, so native Pygments, Prettify,
+Doxygen, and rustdoc token markup cannot produce different results. Dockle
+normalizes common language aliases before highlighting; use `shell` for
+commands and scripts, and reserve `console` for transcripts that include a
+prompt or command output. Line-numbered native source listings retain their
+generator-provided navigation.
+
+Markdown GitHub alerts are enabled through MyST for Sphinx, a
+Dockle Markdown extension for MkDocs and the root portal, Doxygen's native
+parser, and a shared post-render enhancement for JSDoc and rustdoc. Dockle
+extends the same syntax with attention, danger, error, hint, see-also, and todo
+alerts. Its generated Doxyfile also supplies matching Doxygen aliases for
+admonition types that Doxygen does not provide itself. Portable tab sets use
+semantic `details` markup and are upgraded by Dockle's self-contained client
+script with keyboard navigation. An optional `data-dockle-tab-group` name links
+matching selections across tab sets and pages. Doxygen receives equivalent
+`@tab`, `@tabs`, and `@tabs_grouped` aliases without depending on
+`doxygen-awesome-css` or `doxyconfig`.
+
+## Development
+
+The centralized common-lint workflow handles repository linting on pull
+requests. Install the locked Python dependencies and run the test suite:
+
+```shell
+uv sync --locked --all-extras
+$env:PYTHONPATH = "src"  # PowerShell
+python -m unittest discover -s tests -v
+python -m compileall -q src tests
+```
+
+The root documentation is built from [docs/index.rst](docs/index.rst) with the
+same first-party Sphinx theme used by the example. The Sphinx fixture includes
+both MyST Markdown and reStructuredText component references.

lizardbyte_dockle-2026.919.233535/pyproject.toml

@@ -0,0 +1,129 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "lizardbyte-dockle"
+version = "2026.919.233535"
+description = "Build documentation with multiple frameworks and one consistent theme."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+keywords = ["documentation", "doxygen", "jsdoc", "mkdocs", "rustdoc", "sphinx"]
+authors = [
+  { name = "LizardByte" },
+]
+dependencies = [
+  "Markdown>=3.8",
+]
+classifiers = [
+  "Environment :: Console",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: Documentation",
+]
+
+[project.urls]
+Documentation = "https://dockle.readthedocs.io/"
+Issues = "https://github.com/LizardByte/dockle/issues"
+Repository = "https://github.com/LizardByte/dockle"
+
+[project.optional-dependencies]
+sphinx = [
+  "myst-parser>=4.0",
+  "sphinx>=8.1",
+]
+mkdocs = [
+  "mkdocs>=1.6",
+]
+all = [
+  "mkdocs>=1.6",
+  "myst-parser>=4.0",
+  "sphinx>=8.1",
+]
+
+[dependency-groups]
+test = [
+  "pytest==9.1.1",
+  "pytest-cov==7.1.0",
+]
+package = [
+  "pyinstaller==6.22.3",
+  "twine==7.0.0",
+]
+dev = [
+  { include-group = "package" },
+  { include-group = "test" },
+]
+
+[project.scripts]
+dockle = "dockle.cli:main"
+
+[project.entry-points."sphinx.html_themes"]
+dockle = "dockle.sphinx_theme"
+
+[project.entry-points."mkdocs.themes"]
+dockle = "dockle.sphinx.themes.dockle"
+
+[tool.hatch.build]
+artifacts = [
+  "/src/dockle/sphinx/themes/dockle/static/HIGHLIGHT_LICENSE.txt",
+  "/src/dockle/sphinx/themes/dockle/static/LUCIDE_LICENSE.txt",
+  "/src/dockle/sphinx/themes/dockle/static/highlight.min.js",
+  "/src/dockle/sphinx/themes/dockle/static/lucide.min.js",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dockle"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "/LICENSE",
+  "/README.md",
+  "/pyproject.toml",
+  "/src",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = [
+  "-rxXs",
+  "--tb=native",
+  "--verbose",
+  "--color=yes",
+  "-p", "no:cacheprovider",
+  "--cov=src/dockle",
+  "--cov-report=term-missing",
+  "--cov-report=xml:coverage/python-coverage.xml",
+  "--junitxml=junit-python.xml",
+  "-o", "junit_family=legacy",
+]
+
+[tool.coverage.run]
+source = ["src/dockle"]
+omit = [
+  "*/tests/*",
+  "*/__pycache__/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+  "pragma: no cover",
+  "def __repr__",
+  "raise AssertionError",
+  "raise NotImplementedError",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+  "@abstractmethod",
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]

lizardbyte_dockle-2026.919.233535/src/dockle/__init__.py

@@ -0,0 +1,12 @@
+"""Dockle builds documentation with a shared configuration and visual language."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+__all__ = ["__version__"]
+
+try:
+    __version__ = version("lizardbyte-dockle")
+except PackageNotFoundError:  # pragma: no cover - source tree without package metadata
+    __version__ = "0.0.0"

lizardbyte_dockle-2026.919.233535/src/dockle/__main__.py

@@ -0,0 +1,5 @@
+"""Run Dockle with ``python -m dockle``."""
+
+from dockle.cli import main
+
+raise SystemExit(main())