Skip to content

Conversation

@avendesora
Copy link
Owner

@avendesora avendesora commented Jan 1, 2026

Summary by Sourcery

Separate documentation tooling into its own project configuration and bump the core package version to 0.15.4.

Enhancements:

  • Update the core package version to 0.15.4 and align the Sphinx docs configuration with the new release.
  • Introduce a dedicated project configuration for documentation with its own dependencies and linting rules, decoupled from the main package.

Build:

  • Adjust uv configuration so docs are no longer part of the default dependency groups and remove docs-specific extras from the main pyproject.
  • Add a separate pyproject and lockfile under docs/ to manage documentation dependencies independently.

Documentation:

  • Document the 0.15.4 release in the changelog, including the separation of docs dependencies and version/link updates.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 1, 2026

Reviewer's Guide

Splits documentation tooling into its own docs sub-project with separate uv config, removes docs extras from the core package, and bumps project/docs versions and changelog links accordingly.

Flow diagram for environment setup after separating docs configuration

flowchart LR
    Dev[Developer] --> A[Clone pythonbible repo]

    A --> B[Set up core dev env<br>uv sync --group dev --group test]

    A --> C[Set up docs env<br>cd docs]
    C --> D[Create docs environment<br>uv sync]

    B --> E[Work on core code<br>run tests]
    D --> F[Work on docs<br>build docs]
Loading

File-Level Changes

Change Details Files
Remove docs dependencies and lint ignores from the core pythonbible package configuration.
  • Stopped including the docs dependency group in uv default-groups so standard installs only pull dev and test extras.
  • Deleted the docs dependency group from the core optional-dependencies list to decouple Sphinx/Jupyter from the main package.
  • Removed Ruff per-file ignores for docs-specific files from the core project config.
pythonbible/pyproject.toml
Add a dedicated docs project with its own dependencies and lint configuration.
  • Introduced a docs/pyproject.toml defining a separate pythonbible-docs project with explicit Sphinx/Jupyter/furo tooling and a dependency on pythonbible.
  • Configured Ruff for the docs project, including global rule selection, ignores, per-file ignores for notebooks and conf.py, and isort behavior.
  • Added a docs-specific uv.lock to lock the docs environment separately from the core package.
docs/pyproject.toml
docs/uv.lock
Align versions and documentation metadata with the new release.
  • Bumped core pythonbible version from 0.15.3 to 0.15.4 in pyproject and synced the Sphinx release string in docs/source/conf.py.
  • Documented the 0.15.4 release in CHANGELOG, noting docs-config changes and translation package bumps.
  • Updated changelog comparison links so [unreleased] now compares from v0.15.4 and added the 0.15.4 tag link.
pythonbible/pyproject.toml
docs/source/conf.py
CHANGELOG.md

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

@codacy-production
Copy link

codacy-production bot commented Jan 1, 2026

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% 100.00%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (a8c58a9) 2085 2085 100.00%
Head commit (134cafa) 2085 (+0) 2085 (+0) 100.00% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#231) 1 1 100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

@avendesora avendesora merged commit 5a516cb into main Jan 1, 2026
8 of 9 checks passed
@avendesora avendesora deleted the separate-venv-for-docs branch January 1, 2026 21:30
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.

2 participants