Add Sphinx/Doxygen documentation infrastructure and module docstrings#297
Draft
Add Sphinx/Doxygen documentation infrastructure and module docstrings#297
Conversation
…e modules Co-authored-by: NripeshN <86844847+NripeshN@users.noreply.github.com>
Co-authored-by: NripeshN <86844847+NripeshN@users.noreply.github.com>
Co-authored-by: NripeshN <86844847+NripeshN@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add docstrings and initialize Doxygen with Sphinx
Add Sphinx/Doxygen documentation infrastructure and module docstrings
Jan 31, 2026
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.
Adds documentation infrastructure and comprehensive docstrings across the codebase.
Documentation Infrastructure
docs/source/):conf.pywith Napoleon, Breathe, and autodoc extensionsDoxyfile): XML output for Breathe integrationrequirements-docs.txt): sphinx, sphinx-rtd-theme, breatheDocstrings Added
lexer.py,source_registry.py,plugin_loader.py,__init__.py__init__.pyfiles,common_ast.py, key lexer filesBuild
Updated
.gitignoreto excludedocs/_build/anddocs/doxygen/.Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
docs.python.org/home/REDACTED/.local/bin/sphinx-build sphinx-build -b html source _build/html(dns block)/home/REDACTED/.local/bin/sphinx-build sphinx-build -b html source _build/html gen/SPIRV_codegen.py(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.