Repository navigation
Conversation
Rubyfi
marked this pull request as draft
November 2, 2026 12:29
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a dual documentation build system, ensuring that documentation is generated and verified using both Sphinx and ubCode (ubc). It updates documentation, build scripts, configuration files, and adds a license. The main goal is to guarantee that both documentation builds have matching content, with automated checks in CI.
Dual documentation build and verification:
.github/workflows/pr_checks.yml) to generate documentation with both Sphinx and ubCode, and introduced a parity check to ensure both builds have the same content.build_doc_ubc.shfor building docs with ubCode, andcheck_build_parity.pyfor verifying content parity between the two builds. UpdatedREADME.mdto document these scripts and explain the dual build process. [1] [2]ubCode-specific configuration and styling:
docs/_static/ubc-custom.cssto map brand colors and style variables for ubCode’s theme, ensuring visual consistency with the Sphinx (furo) theme.docs/ubproject.tomlto configure ubCode’s HTML builder, including theme, logo, CSS, repository links, and PlantUML integration to match Sphinx’s configuration. Also added custom link handling for source code references. [1] [2]PlantUML update:
docs/conf.pyandubproject.tomlto ensure compatibility with both Sphinx and ubCode builds. [1] [2]Licensing:
README.mdto clarify project licensing. [1] [2]