Update docs action #311
Merged
Update docs action #311
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
ppinchuk
added
chore
castelao
reviewed
Oct 20, 2025
Collaborator
Author
|
@castelao This is ready for review |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation build configuration to fail on warnings and improves documentation quality throughout the codebase. Key changes include configuring Sphinx to use strict validation flags, updating intersphinx mappings, and standardizing docstring formatting across multiple modules.
Key Changes
- Updated Sphinx configuration to fail on warnings with
--fail-on-warning --keep-going --nitpickyflags - Standardized type annotations in docstrings to use Napoleon type aliases
- Renamed internal classes (
Link→_Link,LocalProcessQueueHandler→_LocalProcessQueueHandler, etc.) to follow private naming conventions
Reviewed Changes
Copilot reviewed 37 out of 38 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updated pixi configuration and elm dependency version; added Sphinx error flags |
| docs/source/conf.py | Reorganized intersphinx mappings, expanded Napoleon type aliases, enhanced autodoc filters |
| docs/source/dev/README.rst | Added langchain_text_splitters to intersphinx documentation |
| tests/python/web/test_web_crawl.py | Updated test references from Link to _Link |
| compass/web/website_crawl.py | Renamed Link class to _Link; fixed docstring formatting |
| compass/validation/*.py | Standardized docstring type references to use aliases |
| compass/utilities/*.py | Updated type annotations to use pandas/datetime prefixes |
| compass/services/*.py | Standardized service class docstrings |
| compass/llm/*.py | Enhanced docstrings with See Also sections |
| compass/extraction/**/*.py | Standardized docstring formatting and type references |
| compass/common/*.py | Updated return type annotations |
| .github/workflows/*.yml | Added path filters and updated comments |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
Update docs action to fail on errors
Copilot Summary:
This PR updates documentation build configuration to fail on warnings and improves documentation quality throughout the codebase. Key changes include configuring Sphinx to use strict validation flags, updating intersphinx mappings, and standardizing docstring formatting across multiple modules.
Key Changes
--fail-on-warning --keep-going --nitpickyflagsLink→_Link,LocalProcessQueueHandler→_LocalProcessQueueHandler, etc.) to follow private naming conventionsReviewed Changes
Copilot reviewed 37 out of 38 changed files in this pull request and generated 7 comments.
Show a summary per file
Linkto_LinkLinkclass to_Link; fixed docstring formatting