Skip to content

[NEW] - Full documentation with basic examples and user guide - #46

Merged
ngergihun merged 7 commits into
Quasars:masterfrom
ngergihun:docs
Sep 18, 2026
Merged

ngergihun merged 7 commits into
Quasars:masterfrom
ngergihun:docs

Conversation

@ngergihun

Copy link
Copy Markdown
Contributor

This pull request introduces a comprehensive Sphinx-based documentation system for the project, including configuration files, custom templates, API documentation pages, and styling. The changes enable automatic API documentation generation from docstrings, provide user guidance for building docs, and improve the presentation and organization of documentation content.

Key changes include:

Documentation Infrastructure:

  • Added .readthedocs.yaml for Read the Docs integration and docs/conf.py for Sphinx configuration, enabling automated documentation builds with support for MyST Markdown, NumPy-style docstrings, and several Sphinx extensions. [1] [2]
  • Added a minimal docs/Makefile to simplify local documentation builds using Sphinx.

User Guidance:

  • Updated README.md with instructions for building the documentation locally, detailing dependencies and build commands.

API Documentation Content:

  • Added structured API reference pages (docs/api/*.rst, docs/api/index.md) for each major module, describing classes, transformers, utility functions, and their relationships in detail. [1] [2] [3] [4] [5] [6] [7]

Sphinx Template Customization:

  • Introduced custom Jinja templates for Sphinx autosummary, improving the formatting and navigation of generated API documentation for classes, methods, attributes, and modules. [1] [2] [3] [4] [5] [6] [7]

Styling and Presentation:

  • Added a custom CSS file (docs/_static/custom.css) to enhance the appearance and layout of the documentation, including landing pages and code highlights.

These additions collectively establish a robust, user-friendly, and maintainable documentation system for the project.

@ngergihun
ngergihun merged commit 74f9216 into Quasars:master Sep 18, 2026
12 checks 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.

1 participant