Skip to content

feat: support production multi-framework documentation sites - #6

Merged
ReenigneArcher merged 35 commits into
masterfrom
lizardbyte-fixes
Sep 19, 2026
Merged

ReenigneArcher merged 35 commits into
masterfrom
lizardbyte-fixes

Conversation

@ReenigneArcher

@ReenigneArcher ReenigneArcher commented Sep 18, 2026 •

Copy link
Copy Markdown
Member

Description

Add typed generator configuration for Doxygen, JSDoc, MkDocs, Sphinx, and rustdoc, including project inputs, assets, aliases, warnings, source-edit links, unpublished targets, and remote branding resources.

Allow any framework to serve as the home target, preserve legacy deep links, derive versions from Read the Docs, and add repository actions across every documentation backend.

Centralize hosted builds in a reusable Read the Docs script using a locked uv environment, optional project hooks, and conditional Doxygen tooling.

Harden portal generation, partial builds, CMake integration, and shared theme rendering for navigation, tabs, code highlighting, media, page actions, and responsive layouts.

Expand the documentation, examples, and automated coverage for the new configuration and publishing behavior.

Screenshot

Issues Fixed or Closed

Roadmap Issues

Type of Change

  • feat: New feature (non-breaking change which adds functionality)
  • fix: Bug fix (non-breaking change which fixes an issue)
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
  • refactor: Code change that neither fixes a bug nor adds a feature
  • perf: Code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • build: Changes that affect the build system or external dependencies
  • ci: Changes to CI configuration files and scripts
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit
  • BREAKING CHANGE: Introduces a breaking change (can be combined with any type above)

Checklist

  • Code follows the style guidelines of this project
  • Code has been self-reviewed
  • Code has been commented, particularly in hard-to-understand areas
  • Code docstring/documentation-blocks for new or existing methods/components have been added or updated
  • Unit tests have been added or updated for any new or modified functionality

AI Usage

See our AI usage policy.

  • None: No AI tools were used in creating this PR
  • Light: AI provided minor assistance (formatting, simple suggestions)
  • Moderate: AI helped with code generation or debugging specific parts
  • Heavy: AI generated most or all of the code changes

@codecov

codecov Bot commented Sep 18, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 93.24324% with 35 lines in your changes missing coverage. Please review.
βœ… Project coverage is 92.65%. Comparing base (f59d261) to head (e802b5a).
βœ… All tests successful. No failed tests found.

Files with missing lines Patch % Lines
src/dockle/config.py 90.96% 15 Missing ⚠️
src/dockle/theme.py 94.03% 13 Missing ⚠️
src/dockle/builders.py 94.53% 7 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master       #6      +/-   ##
==========================================
+ Coverage   91.62%   92.65%   +1.03%     
==========================================
  Files          11       11              
  Lines        1301     1743     +442     
  Branches        4        4              
==========================================
+ Hits         1192     1615     +423     
- Misses        109      128      +19     
Flag Coverage Ξ”
Linux-python-3.11 92.40% <93.16%> (+1.39%) ⬆️
Linux-python-3.14 92.40% <93.16%> (+1.39%) ⬆️
Windows-python-3.11 92.57% <93.16%> (+1.33%) ⬆️
Windows-python-3.14 92.57% <93.16%> (+1.33%) ⬆️
macOS-python-3.11 92.40% <93.16%> (+1.39%) ⬆️
macOS-python-3.14 92.40% <93.16%> (+1.39%) ⬆️
node-24 92.59% <100.00%> (-0.30%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Ξ”
publish.js 90.90% <100.00%> (-2.85%) ⬇️
src/dockle/jsdoc_template/publish.js 94.19% <100.00%> (+0.15%) ⬆️
src/dockle/builders.py 93.40% <94.53%> (+4.12%) ⬆️
src/dockle/theme.py 95.32% <94.03%> (+0.36%) ⬆️
src/dockle/config.py 90.83% <90.96%> (-0.12%) ⬇️

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Ξ” = absolute <relative> (impact), ΓΈ = not affected, ? = missing data
Powered by Codecov. Last update f59d261...e802b5a. Read the comment docs.

@read-the-docs-community

read-the-docs-community Bot commented Sep 18, 2026 •

Copy link
Copy Markdown

Comment thread src/dockle/theme.py Fixed
Comment thread src/dockle/theme.py Fixed
@sonarqubecloud

Copy link
Copy Markdown

@ReenigneArcher
ReenigneArcher marked this pull request as ready for review September 19, 2026 20:44
@ReenigneArcher ReenigneArcher changed the title fix: many fixes for first implementation pass feat: support production multi-framework documentation sites Sep 19, 2026
@ReenigneArcher
ReenigneArcher merged commit 87321a8 into master Sep 19, 2026
30 checks passed
@ReenigneArcher
ReenigneArcher deleted the lizardbyte-fixes branch September 19, 2026 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants