Fix documentation build and test CI workflows #48
Conversation
- Update `format_and_test.yml` to use `uv sync --extra dev` and ensure all test dependencies (including `pytest-asyncio`) are installed. - Update `docs_gen.yml` to set up Python and `uv` before building. - Simplify `build-docs.sh` to use `uv` for environment management. - Fix path resolution in compiler scripts (`compiler/docs/compiler.py` and `compiler/errors/compiler.py`) to use absolute paths based on script location. - Pin Sphinx to `< 8.0.0` in `pyproject.toml` for compatibility with `sphinx-immaterial`. - Add `ruff` to `dev` dependencies. Co-authored-by: 5hojib <107526130+5hojib@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Summary of ChangesHello @5hojib, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request aims to fix and improve the reliability of the documentation build and test CI workflows. It achieves this by modernizing the dependency management and command execution using the 'uv' tool, which replaces older 'make' and 'pip' based approaches. The changes also enhance the robustness of internal Python scripts by ensuring correct relative path resolution and introduce new static assets to the documentation output for an improved user experience. Highlights
Ignored Files
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the documentation build process by migrating to uv for dependency management and execution, and by making the compiler scripts more robust with better path handling. The build-docs.sh script is now much cleaner and more reliable.
I have two main points of feedback:
- A potential issue in
build-docs.shwherecompiler/api/compiler.pymight not be prepared to run from the project root, unlike the other compiler scripts that were updated. - A number of generated documentation files under
docs/build/html/have been added to the pull request. These build artifacts should typically be excluded from the repository using.gitignoreto keep the repository clean and focused on source code.
Apart from these points, the changes are a solid improvement to the project's CI/CD pipeline for documentation.
| make api | ||
| "$VENV/bin/pip" install -e '.[docs]' | ||
| uv sync --extra docs | ||
| uv run python compiler/api/compiler.py |
There was a problem hiding this comment.
The compiler/api/compiler.py script is now executed from the repository root. The other compiler scripts (docs and errors) have been updated in this PR to handle this by using absolute paths based on __file__. Has compiler/api/compiler.py been updated similarly? The old build process changed the directory to compiler/api before execution. If this script still uses relative paths, this change might break the build.
| /* | ||
| * Sphinx stylesheet -- basic theme. | ||
| */ | ||
|
|
||
| /* -- main layout ----------------------------------------------------------- */ | ||
|
|
||
| div.clearer { | ||
| clear: both; | ||
| } | ||
|
|
||
| div.section::after { | ||
| display: block; | ||
| content: ''; | ||
| clear: left; | ||
| } | ||
|
|
||
| /* -- relbar ---------------------------------------------------------------- */ | ||
|
|
||
| div.related { | ||
| width: 100%; | ||
| font-size: 90%; | ||
| } | ||
|
|
||
| div.related h3 { | ||
| display: none; | ||
| } | ||
|
|
||
| div.related ul { | ||
| margin: 0; | ||
| padding: 0 0 0 10px; | ||
| list-style: none; | ||
| } | ||
|
|
||
| div.related li { | ||
| display: inline; | ||
| } | ||
|
|
||
| div.related li.right { | ||
| float: right; | ||
| margin-right: 5px; | ||
| } | ||
|
|
||
| /* -- sidebar --------------------------------------------------------------- */ | ||
|
|
||
| div.sphinxsidebarwrapper { | ||
| padding: 10px 5px 0 10px; | ||
| } | ||
|
|
||
| div.sphinxsidebar { | ||
| float: left; | ||
| width: 230px; | ||
| margin-left: -100%; | ||
| font-size: 90%; | ||
| word-wrap: break-word; | ||
| overflow-wrap : break-word; | ||
| } | ||
|
|
||
| div.sphinxsidebar ul { | ||
| list-style: none; | ||
| } | ||
|
|
||
| div.sphinxsidebar ul ul, | ||
| div.sphinxsidebar ul.want-points { | ||
| margin-left: 20px; | ||
| list-style: square; | ||
| } | ||
|
|
||
| div.sphinxsidebar ul ul { | ||
| margin-top: 0; | ||
| margin-bottom: 0; | ||
| } | ||
|
|
||
| div.sphinxsidebar form { | ||
| margin-top: 10px; | ||
| } | ||
|
|
||
| div.sphinxsidebar input { | ||
| border: 1px solid #98dbcc; | ||
| font-family: sans-serif; | ||
| font-size: 1em; | ||
| } | ||
|
|
||
| div.sphinxsidebar #searchbox form.search { | ||
| overflow: hidden; | ||
| } | ||
|
|
||
| div.sphinxsidebar #searchbox input[type="text"] { | ||
| float: left; | ||
| width: 80%; | ||
| padding: 0.25em; | ||
| box-sizing: border-box; | ||
| } | ||
|
|
||
| div.sphinxsidebar #searchbox input[type="submit"] { | ||
| float: left; | ||
| width: 20%; | ||
| border-left: none; | ||
| padding: 0.25em; | ||
| box-sizing: border-box; | ||
| } | ||
|
|
||
|
|
||
| img { | ||
| border: 0; | ||
| max-width: 100%; | ||
| } | ||
|
|
||
| /* -- search page ----------------------------------------------------------- */ | ||
|
|
||
| ul.search { | ||
| margin-top: 10px; | ||
| } | ||
|
|
||
| ul.search li { | ||
| padding: 5px 0; | ||
| } | ||
|
|
||
| ul.search li a { | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| ul.search li p.context { | ||
| color: #888; | ||
| margin: 2px 0 0 30px; | ||
| text-align: left; | ||
| } | ||
|
|
||
| ul.keywordmatches li.goodmatch a { | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| /* -- index page ------------------------------------------------------------ */ | ||
|
|
||
| table.contentstable { | ||
| width: 90%; | ||
| margin-left: auto; | ||
| margin-right: auto; | ||
| } | ||
|
|
||
| table.contentstable p.biglink { | ||
| line-height: 150%; | ||
| } | ||
|
|
||
| a.biglink { | ||
| font-size: 1.3em; | ||
| } | ||
|
|
||
| span.linkdescr { | ||
| font-style: italic; | ||
| padding-top: 5px; | ||
| font-size: 90%; | ||
| } | ||
|
|
||
| /* -- general index --------------------------------------------------------- */ | ||
|
|
||
| table.indextable { | ||
| width: 100%; | ||
| } | ||
|
|
||
| table.indextable td { | ||
| text-align: left; | ||
| vertical-align: top; | ||
| } | ||
|
|
||
| table.indextable ul { | ||
| margin-top: 0; | ||
| margin-bottom: 0; | ||
| list-style-type: none; | ||
| } | ||
|
|
||
| table.indextable > tbody > tr > td > ul { | ||
| padding-left: 0em; | ||
| } | ||
|
|
||
| table.indextable tr.pcap { | ||
| height: 10px; | ||
| } | ||
|
|
||
| table.indextable tr.cap { | ||
| margin-top: 10px; | ||
| background-color: #f2f2f2; | ||
| } | ||
|
|
||
| img.toggler { | ||
| margin-right: 3px; | ||
| margin-top: 3px; | ||
| cursor: pointer; | ||
| } | ||
|
|
||
| div.modindex-jumpbox { | ||
| border-top: 1px solid #ddd; | ||
| border-bottom: 1px solid #ddd; | ||
| margin: 1em 0 1em 0; | ||
| padding: 0.4em; | ||
| } | ||
|
|
||
| div.genindex-jumpbox { | ||
| border-top: 1px solid #ddd; | ||
| border-bottom: 1px solid #ddd; | ||
| margin: 1em 0 1em 0; | ||
| padding: 0.4em; | ||
| } | ||
|
|
||
| /* -- domain module index --------------------------------------------------- */ | ||
|
|
||
| table.modindextable td { | ||
| padding: 2px; | ||
| border-collapse: collapse; | ||
| } | ||
|
|
||
| /* -- general body styles --------------------------------------------------- */ | ||
|
|
||
| div.body { | ||
| min-width: 360px; | ||
| max-width: 800px; | ||
| } | ||
|
|
||
| div.body p, div.body dd, div.body li, div.body blockquote { | ||
| -moz-hyphens: auto; | ||
| -ms-hyphens: auto; | ||
| -webkit-hyphens: auto; | ||
| hyphens: auto; | ||
| } | ||
|
|
||
| a.headerlink { | ||
| visibility: hidden; | ||
| } | ||
|
|
||
| a:visited { | ||
| color: #551A8B; | ||
| } | ||
|
|
||
| h1:hover > a.headerlink, | ||
| h2:hover > a.headerlink, | ||
| h3:hover > a.headerlink, | ||
| h4:hover > a.headerlink, | ||
| h5:hover > a.headerlink, | ||
| h6:hover > a.headerlink, | ||
| dt:hover > a.headerlink, | ||
| caption:hover > a.headerlink, | ||
| p.caption:hover > a.headerlink, | ||
| div.code-block-caption:hover > a.headerlink { | ||
| visibility: visible; | ||
| } | ||
|
|
||
| div.body p.caption { | ||
| text-align: inherit; | ||
| } | ||
|
|
||
| div.body td { | ||
| text-align: left; | ||
| } | ||
|
|
||
| .first { | ||
| margin-top: 0 !important; | ||
| } | ||
|
|
||
| p.rubric { | ||
| margin-top: 30px; | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| img.align-left, figure.align-left, .figure.align-left, object.align-left { | ||
| clear: left; | ||
| float: left; | ||
| margin-right: 1em; | ||
| } | ||
|
|
||
| img.align-right, figure.align-right, .figure.align-right, object.align-right { | ||
| clear: right; | ||
| float: right; | ||
| margin-left: 1em; | ||
| } | ||
|
|
||
| img.align-center, figure.align-center, .figure.align-center, object.align-center { | ||
| display: block; | ||
| margin-left: auto; | ||
| margin-right: auto; | ||
| } | ||
|
|
||
| img.align-default, figure.align-default, .figure.align-default { | ||
| display: block; | ||
| margin-left: auto; | ||
| margin-right: auto; | ||
| } | ||
|
|
||
| .align-left { | ||
| text-align: left; | ||
| } | ||
|
|
||
| .align-center { | ||
| text-align: center; | ||
| } | ||
|
|
||
| .align-default { | ||
| text-align: center; | ||
| } | ||
|
|
||
| .align-right { | ||
| text-align: right; | ||
| } | ||
|
|
||
| /* -- sidebars -------------------------------------------------------------- */ | ||
|
|
||
| div.sidebar, | ||
| aside.sidebar { | ||
| margin: 0 0 0.5em 1em; | ||
| border: 1px solid #ddb; | ||
| padding: 7px; | ||
| background-color: #ffe; | ||
| width: 40%; | ||
| float: right; | ||
| clear: right; | ||
| overflow-x: auto; | ||
| } | ||
|
|
||
| p.sidebar-title { | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| nav.contents, | ||
| aside.topic, | ||
| div.admonition, div.topic, blockquote { | ||
| clear: left; | ||
| } | ||
|
|
||
| /* -- topics ---------------------------------------------------------------- */ | ||
|
|
||
| nav.contents, | ||
| aside.topic, | ||
| div.topic { | ||
| border: 1px solid #ccc; | ||
| padding: 7px; | ||
| margin: 10px 0 10px 0; | ||
| } | ||
|
|
||
| p.topic-title { | ||
| font-size: 1.1em; | ||
| font-weight: bold; | ||
| margin-top: 10px; | ||
| } | ||
|
|
||
| /* -- admonitions ----------------------------------------------------------- */ | ||
|
|
||
| div.admonition { | ||
| margin-top: 10px; | ||
| margin-bottom: 10px; | ||
| padding: 7px; | ||
| } | ||
|
|
||
| div.admonition dt { | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| p.admonition-title { | ||
| margin: 0px 10px 5px 0px; | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| div.body p.centered { | ||
| text-align: center; | ||
| margin-top: 25px; | ||
| } | ||
|
|
||
| /* -- content of sidebars/topics/admonitions -------------------------------- */ | ||
|
|
||
| div.sidebar > :last-child, | ||
| aside.sidebar > :last-child, | ||
| nav.contents > :last-child, | ||
| aside.topic > :last-child, | ||
| div.topic > :last-child, | ||
| div.admonition > :last-child { | ||
| margin-bottom: 0; | ||
| } | ||
|
|
||
| div.sidebar::after, | ||
| aside.sidebar::after, | ||
| nav.contents::after, | ||
| aside.topic::after, | ||
| div.topic::after, | ||
| div.admonition::after, | ||
| blockquote::after { | ||
| display: block; | ||
| content: ''; | ||
| clear: both; | ||
| } | ||
|
|
||
| /* -- tables ---------------------------------------------------------------- */ | ||
|
|
||
| table.docutils { | ||
| margin-top: 10px; | ||
| margin-bottom: 10px; | ||
| border: 0; | ||
| border-collapse: collapse; | ||
| } | ||
|
|
||
| table.align-center { | ||
| margin-left: auto; | ||
| margin-right: auto; | ||
| } | ||
|
|
||
| table.align-default { | ||
| margin-left: auto; | ||
| margin-right: auto; | ||
| } | ||
|
|
||
| table caption span.caption-number { | ||
| font-style: italic; | ||
| } | ||
|
|
||
| table caption span.caption-text { | ||
| } | ||
|
|
||
| table.docutils td, table.docutils th { | ||
| padding: 1px 8px 1px 5px; | ||
| border-top: 0; | ||
| border-left: 0; | ||
| border-right: 0; | ||
| border-bottom: 1px solid #aaa; | ||
| } | ||
|
|
||
| th { | ||
| text-align: left; | ||
| padding-right: 5px; | ||
| } | ||
|
|
||
| table.citation { | ||
| border-left: solid 1px gray; | ||
| margin-left: 1px; | ||
| } | ||
|
|
||
| table.citation td { | ||
| border-bottom: none; | ||
| } | ||
|
|
||
| th > :first-child, | ||
| td > :first-child { | ||
| margin-top: 0px; | ||
| } | ||
|
|
||
| th > :last-child, | ||
| td > :last-child { | ||
| margin-bottom: 0px; | ||
| } | ||
|
|
||
| /* -- figures --------------------------------------------------------------- */ | ||
|
|
||
| div.figure, figure { | ||
| margin: 0.5em; | ||
| padding: 0.5em; | ||
| } | ||
|
|
||
| div.figure p.caption, figcaption { | ||
| padding: 0.3em; | ||
| } | ||
|
|
||
| div.figure p.caption span.caption-number, | ||
| figcaption span.caption-number { | ||
| font-style: italic; | ||
| } | ||
|
|
||
| div.figure p.caption span.caption-text, | ||
| figcaption span.caption-text { | ||
| } | ||
|
|
||
| /* -- field list styles ----------------------------------------------------- */ | ||
|
|
||
| table.field-list td, table.field-list th { | ||
| border: 0 !important; | ||
| } | ||
|
|
||
| .field-list ul { | ||
| margin: 0; | ||
| padding-left: 1em; | ||
| } | ||
|
|
||
| .field-list p { | ||
| margin: 0; | ||
| } | ||
|
|
||
| .field-name { | ||
| -moz-hyphens: manual; | ||
| -ms-hyphens: manual; | ||
| -webkit-hyphens: manual; | ||
| hyphens: manual; | ||
| } | ||
|
|
||
| /* -- hlist styles ---------------------------------------------------------- */ | ||
|
|
||
| table.hlist { | ||
| margin: 1em 0; | ||
| } | ||
|
|
||
| table.hlist td { | ||
| vertical-align: top; | ||
| } | ||
|
|
||
| /* -- object description styles --------------------------------------------- */ | ||
|
|
||
| .sig { | ||
| font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; | ||
| } | ||
|
|
||
| .sig-name, code.descname { | ||
| background-color: transparent; | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| .sig-name { | ||
| font-size: 1.1em; | ||
| } | ||
|
|
||
| code.descname { | ||
| font-size: 1.2em; | ||
| } | ||
|
|
||
| .sig-prename, code.descclassname { | ||
| background-color: transparent; | ||
| } | ||
|
|
||
| .optional { | ||
| font-size: 1.3em; | ||
| } | ||
|
|
||
| .sig-paren { | ||
| font-size: larger; | ||
| } | ||
|
|
||
| .sig-param.n { | ||
| font-style: italic; | ||
| } | ||
|
|
||
| /* C++ specific styling */ | ||
|
|
||
| .sig-inline.c-texpr, | ||
| .sig-inline.cpp-texpr { | ||
| font-family: unset; | ||
| } | ||
|
|
||
| .sig.c .k, .sig.c .kt, | ||
| .sig.cpp .k, .sig.cpp .kt { | ||
| color: #0033B3; | ||
| } | ||
|
|
||
| .sig.c .m, | ||
| .sig.cpp .m { | ||
| color: #1750EB; | ||
| } | ||
|
|
||
| .sig.c .s, .sig.c .sc, | ||
| .sig.cpp .s, .sig.cpp .sc { | ||
| color: #067D17; | ||
| } | ||
|
|
||
|
|
||
| /* -- other body styles ----------------------------------------------------- */ | ||
|
|
||
| ol.arabic { | ||
| list-style: decimal; | ||
| } | ||
|
|
||
| ol.loweralpha { | ||
| list-style: lower-alpha; | ||
| } | ||
|
|
||
| ol.upperalpha { | ||
| list-style: upper-alpha; | ||
| } | ||
|
|
||
| ol.lowerroman { | ||
| list-style: lower-roman; | ||
| } | ||
|
|
||
| ol.upperroman { | ||
| list-style: upper-roman; | ||
| } | ||
|
|
||
| :not(li) > ol > li:first-child > :first-child, | ||
| :not(li) > ul > li:first-child > :first-child { | ||
| margin-top: 0px; | ||
| } | ||
|
|
||
| :not(li) > ol > li:last-child > :last-child, | ||
| :not(li) > ul > li:last-child > :last-child { | ||
| margin-bottom: 0px; | ||
| } | ||
|
|
||
| ol.simple ol p, | ||
| ol.simple ul p, | ||
| ul.simple ol p, | ||
| ul.simple ul p { | ||
| margin-top: 0; | ||
| } | ||
|
|
||
| ol.simple > li:not(:first-child) > p, | ||
| ul.simple > li:not(:first-child) > p { | ||
| margin-top: 0; | ||
| } | ||
|
|
||
| ol.simple p, | ||
| ul.simple p { | ||
| margin-bottom: 0; | ||
| } | ||
|
|
||
| aside.footnote > span, | ||
| div.citation > span { | ||
| float: left; | ||
| } | ||
| aside.footnote > span:last-of-type, | ||
| div.citation > span:last-of-type { | ||
| padding-right: 0.5em; | ||
| } | ||
| aside.footnote > p { | ||
| margin-left: 2em; | ||
| } | ||
| div.citation > p { | ||
| margin-left: 4em; | ||
| } | ||
| aside.footnote > p:last-of-type, | ||
| div.citation > p:last-of-type { | ||
| margin-bottom: 0em; | ||
| } | ||
| aside.footnote > p:last-of-type:after, | ||
| div.citation > p:last-of-type:after { | ||
| content: ""; | ||
| clear: both; | ||
| } | ||
|
|
||
| dl.field-list { | ||
| display: grid; | ||
| grid-template-columns: fit-content(30%) auto; | ||
| } | ||
|
|
||
| dl.field-list > dt { | ||
| font-weight: bold; | ||
| word-break: break-word; | ||
| padding-left: 0.5em; | ||
| padding-right: 5px; | ||
| } | ||
|
|
||
| dl.field-list > dd { | ||
| padding-left: 0.5em; | ||
| margin-top: 0em; | ||
| margin-left: 0em; | ||
| margin-bottom: 0em; | ||
| } | ||
|
|
||
| dl { | ||
| margin-bottom: 15px; | ||
| } | ||
|
|
||
| dd > :first-child { | ||
| margin-top: 0px; | ||
| } | ||
|
|
||
| dd ul, dd table { | ||
| margin-bottom: 10px; | ||
| } | ||
|
|
||
| dd { | ||
| margin-top: 3px; | ||
| margin-bottom: 10px; | ||
| margin-left: 30px; | ||
| } | ||
|
|
||
| .sig dd { | ||
| margin-top: 0px; | ||
| margin-bottom: 0px; | ||
| } | ||
|
|
||
| .sig dl { | ||
| margin-top: 0px; | ||
| margin-bottom: 0px; | ||
| } | ||
|
|
||
| dl > dd:last-child, | ||
| dl > dd:last-child > :last-child { | ||
| margin-bottom: 0; | ||
| } | ||
|
|
||
| dt:target, span.highlighted { | ||
| background-color: #fbe54e; | ||
| } | ||
|
|
||
| rect.highlighted { | ||
| fill: #fbe54e; | ||
| } | ||
|
|
||
| dl.glossary dt { | ||
| font-weight: bold; | ||
| font-size: 1.1em; | ||
| } | ||
|
|
||
| .versionmodified { | ||
| font-style: italic; | ||
| } | ||
|
|
||
| .system-message { | ||
| background-color: #fda; | ||
| padding: 5px; | ||
| border: 3px solid red; | ||
| } | ||
|
|
||
| .footnote:target { | ||
| background-color: #ffa; | ||
| } | ||
|
|
||
| .line-block { | ||
| display: block; | ||
| margin-top: 1em; | ||
| margin-bottom: 1em; | ||
| } | ||
|
|
||
| .line-block .line-block { | ||
| margin-top: 0; | ||
| margin-bottom: 0; | ||
| margin-left: 1.5em; | ||
| } | ||
|
|
||
| .guilabel, .menuselection { | ||
| font-family: sans-serif; | ||
| } | ||
|
|
||
| .accelerator { | ||
| text-decoration: underline; | ||
| } | ||
|
|
||
| .classifier { | ||
| font-style: oblique; | ||
| } | ||
|
|
||
| .classifier:before { | ||
| font-style: normal; | ||
| margin: 0 0.5em; | ||
| content: ":"; | ||
| display: inline-block; | ||
| } | ||
|
|
||
| abbr, acronym { | ||
| border-bottom: dotted 1px; | ||
| cursor: help; | ||
| } | ||
|
|
||
| /* -- code displays --------------------------------------------------------- */ | ||
|
|
||
| pre { | ||
| overflow: auto; | ||
| overflow-y: hidden; /* fixes display issues on Chrome browsers */ | ||
| } | ||
|
|
||
| pre, div[class*="highlight-"] { | ||
| clear: both; | ||
| } | ||
|
|
||
| span.pre { | ||
| -moz-hyphens: none; | ||
| -ms-hyphens: none; | ||
| -webkit-hyphens: none; | ||
| hyphens: none; | ||
| white-space: nowrap; | ||
| } | ||
|
|
||
| div[class*="highlight-"] { | ||
| margin: 1em 0; | ||
| } | ||
|
|
||
| td.linenos pre { | ||
| border: 0; | ||
| background-color: transparent; | ||
| color: #aaa; | ||
| } | ||
|
|
||
| table.highlighttable { | ||
| display: block; | ||
| } | ||
|
|
||
| table.highlighttable tbody { | ||
| display: block; | ||
| } | ||
|
|
||
| table.highlighttable tr { | ||
| display: flex; | ||
| } | ||
|
|
||
| table.highlighttable td { | ||
| margin: 0; | ||
| padding: 0; | ||
| } | ||
|
|
||
| table.highlighttable td.linenos { | ||
| padding-right: 0.5em; | ||
| } | ||
|
|
||
| table.highlighttable td.code { | ||
| flex: 1; | ||
| overflow: hidden; | ||
| } | ||
|
|
||
| .highlight .hll { | ||
| display: block; | ||
| } | ||
|
|
||
| div.highlight pre, | ||
| table.highlighttable pre { | ||
| margin: 0; | ||
| } | ||
|
|
||
| div.code-block-caption + div { | ||
| margin-top: 0; | ||
| } | ||
|
|
||
| div.code-block-caption { | ||
| margin-top: 1em; | ||
| padding: 2px 5px; | ||
| font-size: small; | ||
| } | ||
|
|
||
| div.code-block-caption code { | ||
| background-color: transparent; | ||
| } | ||
|
|
||
| table.highlighttable td.linenos, | ||
| span.linenos, | ||
| div.highlight span.gp { /* gp: Generic.Prompt */ | ||
| user-select: none; | ||
| -webkit-user-select: text; /* Safari fallback only */ | ||
| -webkit-user-select: none; /* Chrome/Safari */ | ||
| -moz-user-select: none; /* Firefox */ | ||
| -ms-user-select: none; /* IE10+ */ | ||
| } | ||
|
|
||
| div.code-block-caption span.caption-number { | ||
| padding: 0.1em 0.3em; | ||
| font-style: italic; | ||
| } | ||
|
|
||
| div.code-block-caption span.caption-text { | ||
| } | ||
|
|
||
| div.literal-block-wrapper { | ||
| margin: 1em 0; | ||
| } | ||
|
|
||
| code.xref, a code { | ||
| background-color: transparent; | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { | ||
| background-color: transparent; | ||
| } | ||
|
|
||
| .viewcode-link { | ||
| float: right; | ||
| } | ||
|
|
||
| .viewcode-back { | ||
| float: right; | ||
| font-family: sans-serif; | ||
| } | ||
|
|
||
| div.viewcode-block:target { | ||
| margin: -1px -10px; | ||
| padding: 0 10px; | ||
| } | ||
|
|
||
| /* -- math display ---------------------------------------------------------- */ | ||
|
|
||
| img.math { | ||
| vertical-align: middle; | ||
| } | ||
|
|
||
| div.body div.math p { | ||
| text-align: center; | ||
| } | ||
|
|
||
| span.eqno { | ||
| float: right; | ||
| } | ||
|
|
||
| span.eqno a.headerlink { | ||
| position: absolute; | ||
| z-index: 1; | ||
| } | ||
|
|
||
| div.math:hover a.headerlink { | ||
| visibility: visible; | ||
| } | ||
|
|
||
| /* -- printout stylesheet --------------------------------------------------- */ | ||
|
|
||
| @media print { | ||
| div.document, | ||
| div.documentwrapper, | ||
| div.bodywrapper { | ||
| margin: 0 !important; | ||
| width: 100%; | ||
| } | ||
|
|
||
| div.sphinxsidebar, | ||
| div.related, | ||
| div.footer, | ||
| #top-link { | ||
| display: none; | ||
| } | ||
| } No newline at end of file |
There was a problem hiding this comment.
It appears that generated documentation files from the docs/build/html/ directory are being included in this pull request. It's a common best practice to exclude build artifacts from source control. Committing generated files can lead to a larger repository size, cause unnecessary merge conflicts, and complicate code reviews.
Consider adding docs/build/ to your .gitignore file to prevent these files from being tracked. The CI pipeline should be responsible for generating and deploying these files, as the build-docs.sh script seems to be doing for the documentation site.
The CI workflows for building documentation and running tests were failing due to inconsistent environment setups and brittle path handling in the compiler scripts.
Key changes:
uvfor bothformat_and_test.ymlanddocs_gen.yml. This ensures that all required dependencies, including optional extras likedev(for tests) anddocs(for documentation), are correctly installed and synchronized. Added explicit Python anduvsetup steps to the documentation build workflow.compiler/docs/compiler.pyandcompiler/errors/compiler.pyto resolve paths relative to the script's own location usingPath(__file__). This allows them to be executed reliably from any working directory, including the repository root during CI runs.ruffto thedevdependency group inpyproject.tomlto ensure it is available in the project environment.sphinx < 8.0.0to maintain compatibility with thesphinx-immaterialtheme.build-docs.shto leverageuv runfor executing compilers andsphinx-build, eliminating the need for manual virtual environment management and increasing build reliability.PR created automatically by Jules for task 6306522225929716999 started by @5hojib