Skip to content

Add docs#8

Merged
rartino merged 2 commits intomainfrom
develop
Mar 27, 2026
Merged

Add docs#8
rartino merged 2 commits intomainfrom
develop

Conversation

@rartino
Copy link
Copy Markdown
Member

@rartino rartino commented Mar 27, 2026

No description provided.

Copilot AI review requested due to automatic review settings March 27, 2026 01:00
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds initial Sphinx documentation scaffolding for httk-web, including an API reference (autodoc) and a GitHub Pages deployment workflow.

Changes:

  • Introduces Sphinx docs structure (index, “How It Works”, and API reference pages).
  • Adds Sphinx configuration (docs/conf.py) enabling autodoc/autosummary and the Furo theme.
  • Adds a GitHub Actions workflow to build and deploy docs to GitHub Pages.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
docs/index.rst Adds docs landing page and toctree.
docs/how_it_works.rst Documents runtime flow, directory layout, and compatibility mode.
docs/reference.rst Adds autodoc-based API reference pages.
docs/conf.py Sphinx configuration for autodoc/theme/extensions.
.github/workflows/docs.yml CI workflow intended to build and deploy docs to GitHub Pages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@rartino rartino merged commit f52944f into main Mar 27, 2026
1 check passed
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