Open
Conversation
Pull Request Test Coverage Report for Build 18984393558Details
💛 - Coveralls |
Owner
|
@akaihola This seems like a nice addition. Can you address the failing tests? |
Author
Fixed! |
|
This is great! I pulled it into an experimental PR to try and use it to generate a llms-full.txt and noticed an issue with how some of the headings were generated: ## Changelog
# Changelog
## 0.7.0
- Add `llms_txt_uri_template` configuration option to control the link behavior in `llms_txt_filename`.
[#48](https://github.com/jdillard/sphinx-llms-txt/pull/48)
### 0.6.0
- Improve \_sources directory handling
[#47](https://github.com/jdillard/sphinx-llms-txt/pull/47)
#### 0.5.3
- Make sphinx a required dependency since there are imports from Sphinx
[#44](https://github.com/jdillard/sphinx-llms-txt/pull/44)
##### 0.5.2
- Remove support for singlehtml
[#40](https://github.com/jdillard/sphinx-llms-txt/pull/40)
###### 0.5.1
- Only allow builders that have \_sources directory
[#38](https://github.com/jdillard/sphinx-llms-txt/pull/38)The headings look fine on the normal markdown builder for that page: https://sphinx-llms-txt--51.org.readthedocs.build/en/51/changelog.md edit: I made a (AI generated) PR here: akaihola#1 |
This was referenced Oct 28, 2025
Author
|
Thanks @jdillard! Obviously the original behavior is wrong. I'd like to add a failing unit test for your example case in this PR, and then verify that jdillard/sphinx-llms-txt#51 fixes it. I'll also rebase on |
This commit adds a functional SingleFileMarkdownBuilder that generates a single consolidated Markdown file from Sphinx documentation rather than separate files for each document. Key changes: - Complete implementation of SingleFileMarkdownBuilder with custom write_documents() method - Add custom SingleMarkdownTranslator to properly handle document anchors and styling - Add table of contents and document anchors to improve navigation in the single file - Simplify cross-references by using document anchors within the same file - Reformat test file to follow code style without functional changes The builder can be used with: sphinx-build -M singlemarkdown ./docs ./build The output will be a single file at ./build/singlemarkdown/<root_doc>.md
…tion errors - Refactor setup function in __init__.py with proper type hints and return metadata - Update singlemarkdown.py to follow Sphinx extension pattern by removing duplicate builder registration - Follow pattern from Sphinx's singlehtml.py implementation - Ensure proper extension loading through app.setup_extension
This commit adds the missing render_partial method to the SingleFileMarkdownBuilder class, which resolves the 'no-member' errors in the singlemarkdown.py file. The implementation: - Creates a proper render_partial method based on Sphinx's similar functionality - Uses StringOutput instead of StringIO for proper document rendering - Ensures correct type handling for method return values - Updates write_documents method to use StringOutput for consistency Fixes E1101: Instance of 'SingleFileMarkdownBuilder' has no 'render_partial' member (no-member)
- Add proper type annotations to class attributes and method parameters/return types - Fix potential type incompatibilities with appropriate casts - Add pyright-specific comments to suppress false positives - Improve variable naming and eliminate unused variables - Replace implicit variable assignments with explicit ones using underscore
…nnotations - Add extensive unit tests for SingleFileMarkdownBuilder methods - Create separate test file for SingleMarkdownTranslator - Improve Path handling in tests using pathlib - Add proper type annotations for MarkdownWriter variable - Test error handling and edge cases for better coverage
- Add parametrized tests to test singlemarkdown with various configuration options - Test handling of missing build directories - Test handling of file permission issues - Match the integration test pattern from test_builder.py - Enhance error handling and coverage
akaihola
force-pushed
the
singlemarkdown
branch
from
ff7719d to
e78f773
Compare
liran-funaro
force-pushed
the
main
branch
2 times, most recently
from
dbd4524 to
07dd84e
Compare
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
4 participants
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.
Similar to the
singlehtmlbuilt-in builder in Sphinx, thesinglemarkdownbuilder collects all documentation pages together in a single.mdfile.This is useful e.g. for providing documentation of a Python package to a language model / coding agent.