Skip to content

Conversation

@mdevolde
Copy link
Collaborator

docs: added auto-genereted doc (sphinx), corrected the way of writing class attributes

Why the pull request was made

To make the documentation fully compliant with reStructuredText, and enable automatic generation of the documentation.

Summary of changes

  • Edited doc to fit in reStructuredText rules
  • Added auto generated doc (sphinx)
  • Edited optional dependencies (from opt to groups)

Screenshots (if appropriate):

Not applicable.

How has this been tested?

Applied local tests.

Resources

Not applicable.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (changes to documentation only)
  • Refactor / code style update (non-breaking change that improves code structure or readability)
  • Tests / CI improvement (adding or updating tests or CI configuration only)
  • Other (please describe):

Checklist

  • Followed the project's contributing guidelines.
  • Updated any relevant tests.
  • Updated any relevant documentation.
  • Added comments to your code where necessary.
  • Formatted your code, run the linters and tests.

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 enhances the documentation infrastructure by adding Sphinx-based auto-generated documentation and converting inline documentation to be fully compliant with reStructuredText formatting standards.

  • Converted class attribute documentation from inline Attributes sections to class-level attribute declarations with docstrings
  • Changed backtick formatting from single to double backticks for proper reStructuredText code references
  • Added Sphinx documentation infrastructure with configuration, build files, and auto-generated module references

Reviewed Changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
pyproject.toml Updated dependency management from [project.optional-dependencies] to [dependency-groups] format and added documentation dependencies (furo, sphinx, sphinx-design)
language_tool_python/utils.py Converted single backtick code references to double backticks for reStructuredText compliance
language_tool_python/server.py Restructured class attributes documentation from inline format to class-level declarations with individual docstrings
language_tool_python/match.py Restructured Match class attributes documentation and converted example code block to use proper .. code-block:: directive
language_tool_python/language_tag.py Restructured LanguageTag class attributes documentation to class-level format
language_tool_python/exceptions.py Updated exception docstrings to use double backticks for class references
language_tool_python/download_lt.py Changed comment quote style from backticks to single quotes
language_tool_python/config_file.py Restructured OptionSpec and LanguageToolConfig class attributes documentation
language_tool_python/main.py Updated RulesAction class to use reStructuredText .. attribute:: directive
docs/source/conf.py Added Sphinx configuration file with project metadata and autodoc settings
docs/source/index.rst Created documentation index page with project description
docs/source/references/modules.rst Added top-level modules reference file
docs/source/references/language_tool_python.rst Added auto-generated API reference for all modules
docs/Makefile Added Makefile for building Sphinx documentation on Unix systems
docs/make.bat Added batch file for building Sphinx documentation on Windows

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

@mdevolde mdevolde merged commit 923cef4 into jxmorris12:master Nov 17, 2025
7 checks passed
@mdevolde mdevolde deleted the auto_doc branch November 17, 2025 13:43
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