Fix Sphinx documentation build errors#725
Merged
AndyTheFactory merged 2 commits intomasterfrom Apr 7, 2026
Merged
Conversation
…ocstring indentation Agent-Logs-Url: https://github.com/AndyTheFactory/newspaper4k/sessions/aebc793b-4ef1-4fd3-b421-a31900490635 Co-authored-by: AndyTheFactory <863810+AndyTheFactory@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
AndyTheFactory
April 5, 2026 21:33
View session
AndyTheFactory
approved these changes
Apr 7, 2026
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.
Summary
Fixes all Sphinx/docutils errors reported in the documentation build.
Changes
RST files
docs/user_guide/advanced.rst: Changed all^^^^title underlines to~~~~in subsections under "Google News Integration", "Cloudscraper Integration", and "Respecting robots.txt" sections (15 occurrences) — fixes "Title level inconsistent" CRITICAL errorsdocs/user_guide/faq.rst: Extended 4 title underlines that were shorter than their titles — fixes "Title underline too short" warningsdocs/user_guide/known_newssites.rst: Extended the title underline for "Well Known News Websites Supported by newspaper4k" — fixes "Title underline too short" warningdocs/index.rst: Addeduser_guide/faqto the toctree — fixes "document isn't included in any toctree" warningPython docstrings
newspaper/configuration.py:top_image_settingsattribute description (RST requires blank lines before lists) — fixes "Unexpected indentation" ERROR at line 72use_cached_categoriesand_honor_robotstxtattribute descriptionsignored_content_types_defaultsdescriptionnewspaper/article.py:.. deprecated::directives intext_cleanedandclean_docclass attribute descriptions (RST requires blank lines before directives) — fixes "Unexpected indentation" ERRORs at lines 96 and 247configparameter continuation indentation in__init__docstring