Skip to content

Alpha - #4

Merged
swainsubrat merged 8 commits into
mainfrom
alpha
Nov 10, 2025
Merged

swainsubrat merged 8 commits into
mainfrom
alpha

Conversation

@swainsubrat

Copy link
Copy Markdown
Member

No description provided.

swainsubrat and others added 6 commits November 11, 2025 01:27
Co-authored-by: swainsubrat <37792158+swainsubrat@users.noreply.github.com>
Co-authored-by: swainsubrat <37792158+swainsubrat@users.noreply.github.com>
Add comprehensive Sphinx documentation for Titli project
@swainsubrat
swainsubrat requested a review from Copilot November 10, 2025 20:24

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 adds comprehensive Sphinx-based documentation for the Titli project, including installation guides, quick start tutorials, detailed usage examples, and complete API reference documentation. The version is bumped from 0.0.9 to 0.0.10 in pyproject.toml.

  • Adds complete documentation structure with Sphinx configuration, installation guide, quickstart guide, usage guide, API reference, changelog, and license information
  • Implements GitHub Actions workflow for automated documentation building
  • Updates README with documentation references and build instructions

Reviewed Changes

Copilot reviewed 18 out of 20 changed files in this pull request and generated 12 comments.

Show a summary per file
File Description
pyproject.toml Bumps version from 0.0.9 to 0.0.10
docs/source/conf.py Adds Sphinx configuration for documentation build
docs/source/index.rst Creates main documentation landing page with table of contents
docs/source/installation.rst Adds installation instructions for the library
docs/source/quickstart.rst Provides quick start guide with basic examples
docs/source/usage.rst Adds detailed usage guide with extensive code examples
docs/source/changelog.rst Documents version history and changes
docs/source/license.rst Includes MIT license information and third-party licenses
docs/source/api/fe.rst API reference for feature extractors module
docs/source/api/ids.rst API reference for IDS models module
docs/source/api/utils.rst API reference for utilities module
docs/requirements.txt Specifies Sphinx and related dependencies for documentation
docs/Makefile Adds Unix/Linux build commands for documentation
docs/make.bat Adds Windows build commands for documentation
docs/README.md Provides guide for building and maintaining documentation
.gitignore Adds docs/build/ to ignored paths
.github/workflows/docs.yml Implements CI/CD workflow for documentation building
.github/copilot-instructions.md Adds GitHub Copilot guidance for code generation
README.md Updates with documentation links and build instructions

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

Comment thread docs/source/conf.py Resolved
Comment thread docs/source/changelog.rst Resolved
Comment thread docs/source/quickstart.rst Resolved
Comment thread docs/source/usage.rst Resolved
Comment thread docs/source/usage.rst Resolved
Comment thread docs/source/usage.rst Resolved
Comment thread docs/README.md Resolved
Comment thread docs/source/quickstart.rst Resolved
Comment thread docs/source/usage.rst Resolved
Comment thread docs/source/usage.rst Resolved
swainsubrat and others added 2 commits November 11, 2025 01:59
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@swainsubrat
swainsubrat merged commit 8bddb56 into main Nov 10, 2025
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.

3 participants