Skip to content

Sphinx docs integration#421

Open
trushant05 wants to merge 25 commits intomainfrom
trushant/sphinx_docs
Open

Sphinx docs integration#421
trushant05 wants to merge 25 commits intomainfrom
trushant/sphinx_docs

Conversation

@trushant05
Copy link
Copy Markdown
Collaborator

@trushant05 trushant05 commented Mar 10, 2026

Summary

Sphinx-based documentation generation workflow is introduced in this PR.

Contents

  • aic_docs/Dockerfile : Introduced inside docker/ to provide a consistent environment for Sphinx docs generation.
  • conf.py: Located inside docs/, this file handles all Sphinx-specific configurations, including Markdown parsing and theme settings.
  • GitHub Action: Added .github/workflows/build_sphinx_docs.yml which triggers specifically on changes to the docs/ directory.

Preview from Github Action

  1. Look at the latest run of Sphinx Docs Github Action,
  2. Look at the specific Build Docs job.
  3. In the Update docs artifact step you can download build artifact.
  4. Extract and open index.html.

Preview and Update Locally

  • Fetch image assets from media branch into aic/../:
    ./docker/aic_docs/fetch_docs_assets.sh

Note

Above script will clone aic repo media branch at the same directory level as aic.

├── aic
│   ├── docker
│   ├── docs
├── media
  • Build aic_docs docker image:

    cd docker
    docker compose build docs
  • Start docs compose service to serve Sphinx docs:

     docker compose up docs

Note

Documentation will be served on localhost at port 8000.

@trushant05 trushant05 self-assigned this Mar 10, 2026
@trushant05 trushant05 marked this pull request as ready for review March 10, 2026 21:54
@trushant05 trushant05 requested a review from Yadunund March 10, 2026 21:54
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.

1 participant