Skip to content

Fix Read the Docs build#2

Merged
Aurelien7777 merged 1 commit into
masterfrom
fix/read-the-docs-build
Jun 23, 2026
Merged

Fix Read the Docs build#2
Aurelien7777 merged 1 commit into
masterfrom
fix/read-the-docs-build

Conversation

@Aurelien7777

@Aurelien7777 Aurelien7777 commented Jun 23, 2026

Copy link
Copy Markdown
Owner

Correction

  • suppression des chemins vers les dossiers Sphinx _templates et _static dans conf.py ;
  • ces dossiers étant vides et non suivis par Git, Read the Docs générait des avertissements ;
  • les avertissements étaient traités comme des erreurs par Read the Docs et bloquaient la construction de la documentation.

Vérification

  • génération locale testée avec les avertissements considérés comme des erreurs ;
  • build Sphinx réussi sans avertissement.
sphinx-build -W --keep-going -b html docs/source docs/build/html

Summary by Sourcery

Fix Sphinx configuration to prevent empty template and static directory warnings from breaking the Read the Docs build.

Bug Fixes:

  • Remove references to empty _templates and _static directories in Sphinx configuration to eliminate warnings treated as errors on Read the Docs.

Documentation:

  • Adjust Sphinx docs configuration to build cleanly without relying on unused template and static directories.

@sourcery-ai

sourcery-ai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR adjusts the Sphinx documentation configuration so that Read the Docs no longer treats missing empty template/static directories as errors, by disabling their use in the config.

File-Level Changes

Change Details Files
Stop referencing empty Sphinx template and static directories so RTD builds no longer fail on warnings.
  • Set templates_path to an empty list to avoid using a non-existent _templates directory.
  • Set html_static_path to an empty list to avoid using a non-existent _static directory.
docs/source/conf.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Aurelien7777 Aurelien7777 merged commit dcb61e0 into master Jun 23, 2026
7 checks passed
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