Skip to content

Conversation

@jacksonpradolima
Copy link
Owner

Summary

  • add MkDocs configuration and documentation pages for usage, CLI, API (via mkdocstrings), acceleration, benchmarks, contributing, and typing guidance
  • add doc-friendly examples to the public API and introduce a docs optional dependency set for building the site
  • add a documentation workflow to build docs on pull requests and publish to GitHub Pages on releases
  • update the README with the live docs link, local MkDocs build instructions, and a documentation badge

Testing

  • python -m compileall gsppy
  • uv sync --extra docs --dry-run (fails locally due to proxy blocking access to PyPI; docs workflow still uses this command and should succeed in CI with network access)

Codex Task

@sonarqubecloud
Copy link

Copy link
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

This PR establishes a comprehensive MkDocs-based documentation site for GSP-Py with automated CI/CD publishing to GitHub Pages.

  • Adds MkDocs configuration with Material theme and mkdocstrings for API reference generation
  • Creates user-facing documentation covering installation, usage, CLI, acceleration backends, benchmarks, contributing guidelines, and typing
  • Implements a GitHub Actions workflow to build docs on pull requests and deploy to GitHub Pages on releases
  • Updates README with documentation badge and local build instructions

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.

Show a summary per file
File Description
pyproject.toml Adds docs optional dependency group with MkDocs, mkdocstrings, and Material theme packages
mkdocs.yml Configures MkDocs site with navigation, Material theme, mkdocstrings plugin for Python API docs, and markdown extensions
gsppy/gsp.py Adds example code snippet to the search method docstring demonstrating basic usage
gsppy/accelerate.py Adds example code snippet to the support_counts function docstring showing explicit backend selection
docs/usage.md Documents installation methods, basic search usage, backend selection, and CLI entry point
docs/typing.md Describes the project's type checking approach with Pyright and compatibility with mkdocstrings
docs/index.md Provides landing page with quickstart example and highlights of library features
docs/contributing.md Outlines development setup with uv, quality checks, and pull request guidelines
docs/cli.md Documents command-line interface usage, options, and examples
docs/benchmarks.md Explains how to run benchmark scripts for performance testing
docs/api.md Configures mkdocstrings to auto-generate API reference from GSP class and support_counts function
docs/acceleration.md Details available backends (Rust, GPU, Python, auto) and installation instructions for each
README.md Adds documentation badge, restructures table of contents, and includes section on building docs locally
.github/workflows/docs.yml Implements CI workflow to build docs on PRs and deploy to GitHub Pages on releases

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

@jacksonpradolima jacksonpradolima merged commit 25dc379 into master Dec 28, 2025
18 checks passed
@jacksonpradolima jacksonpradolima deleted the codex/add-documentation-with-mkdocs-setup branch December 28, 2025 02:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants