Add Pydoctor documentation support to librovore #4
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
Implement structure processor for extracting API documentation content from Pydoctor-generated sites (e.g., Twisted, Dulwich). New features: - Detection via meta tags, CSS markers, and HTML structure patterns - Content extraction for docstrings, signatures, and code examples - HTML to Markdown conversion with Bootstrap cleanup - URL utilities for proper ParseResult type handling Package structure: - sources/librovore/structures/pydoctor/__init__.py - Registration - sources/librovore/structures/pydoctor/main.py - PydoctorProcessor class - sources/librovore/structures/pydoctor/detection.py - Site detection logic - sources/librovore/structures/pydoctor/extraction.py - Content extraction - sources/librovore/structures/pydoctor/conversion.py - HTML conversion - sources/librovore/structures/pydoctor/urls.py - URL manipulation Configuration: - Added pydoctor structure extension to general.toml Quality assurance: - All linters pass (ruff, isort, pyright) - All tests pass (171 tests) - Follows project coding standards and practices
Code quality improvements: - Remove blank lines within function bodies - Narrow overly-broad try block in detect_pydoctor - Simplify return statement (remove unnecessary assignment) Documentation: - Document SSL/TLS certificate verification issue in issues.md - Document normalize_base_url code duplication in issues.md Changes follow project coding standards. All linters pass. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
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.
Implement structure processor for extracting API documentation content from Pydoctor-generated sites (e.g., Twisted, Dulwich).
New features:
Package structure:
Configuration:
Quality assurance: