Skip to content

Add Sphinx/Doxygen documentation infrastructure and module docstrings#297

Draft
Copilot wants to merge 4 commits intomainfrom
copilot/add-docstrings-and-doxygen
Draft

Add Sphinx/Doxygen documentation infrastructure and module docstrings#297
Copilot wants to merge 4 commits intomainfrom
copilot/add-docstrings-and-doxygen

Conversation

Copy link
Copy Markdown

Copilot AI commented Jan 31, 2026

Adds documentation infrastructure and comprehensive docstrings across the codebase.

Documentation Infrastructure

  • Sphinx setup (docs/source/): conf.py with Napoleon, Breathe, and autodoc extensions
  • Doxygen config (Doxyfile): XML output for Breathe integration
  • Doc pages: Getting started, API reference, backend docs, contributing guide
  • Dependencies (requirements-docs.txt): sphinx, sphinx-rtd-theme, breathe

Docstrings Added

  • Translator module: lexer.py, source_registry.py, plugin_loader.py, __init__.py
  • Codegen module: All 10 generators (Metal, DirectX, GLSL, SPIR-V, CUDA, HIP, Mojo, Rust, Slang) + registry
  • Backend modules: All 9 backend __init__.py files, common_ast.py, key lexer files

Build

cd docs && pip install -r ../requirements-docs.txt && sphinx-build -b html source _build/html

Updated .gitignore to exclude docs/_build/ and docs/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
    • Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -b html source _build/html (dns block)
    • Triggering command: /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

Add docstrings to each and everything in our codebase and initialise doxygen into our codebase with sphinx.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits January 31, 2026 21:12
…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
Copilot AI requested a review from NripeshN January 31, 2026 21:20
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