Repository navigation
[NEW] - Full documentation with basic examples and user guide - #46
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
.readthedocs.yamlfor Read the Docs integration anddocs/conf.pyfor Sphinx configuration, enabling automated documentation builds with support for MyST Markdown, NumPy-style docstrings, and several Sphinx extensions. [1] [2]docs/Makefileto simplify local documentation builds using Sphinx.User Guidance:
README.mdwith instructions for building the documentation locally, detailing dependencies and build commands.API Documentation Content:
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:
Styling and Presentation:
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.