Skip to content

Fix: tox docs testenv extras#78

Merged
seetadev merged 1 commit into
ipld:masterfrom
sumanjeet0012:fix-ci-cd-pipelines
Jul 13, 2026
Merged

Fix: tox docs testenv extras#78
seetadev merged 1 commit into
ipld:masterfrom
sumanjeet0012:fix-ci-cd-pipelines

Conversation

@sumanjeet0012

@sumanjeet0012 sumanjeet0012 commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Closes #79

Description

This PR fixes an issue where the tox job for docs fails instantly during the CI/CD pipeline.

The tox.ini file erroneously referenced . in the extras section for [testenv:docs]. Since . is not a named optional-dependency group in pyproject.toml, tox instantly failed with docs: failed with extras not found for package py-cid: - (available: dev).

Changes

  • Removed the invalid . entry from the extras list under [testenv:docs] in tox.ini. The dev extra correctly remains.

Verification

  • Ran tox -e docs locally and verified that it successfully skips the config failure, installs the dev dependencies, and successfully builds the HTML documentation using make check-docs-ci.

@seetadev

Copy link
Copy Markdown
Contributor

Thanks for the contribution, @sumanjeet0012. This is a clean and well-targeted fix.

The root cause has been identified clearly, the docs tox environment was incorrectly referencing . in the extras list, even though only the dev optional dependency group is defined in pyproject.toml. Removing the invalid entry resolves the immediate configuration failure and restores the documentation CI workflow.

I also appreciate the verification steps included in the PR. Confirming that tox -e docs runs successfully and that the documentation builds correctly via make check-docs-ci gives good confidence that the change fixes the issue without introducing regressions.

CI and developer experience improvements like this are valuable. A reliable documentation pipeline makes it easier for contributors to validate changes locally and helps keep our automated workflows healthy.

All checks are passing, the change is minimal, and it addresses the reported issue directly.

LGTM. Thanks for the fix and for improving the project's CI experience! Happy to merge.

CCing @acul71, @johannamoran and @mishmosh.

@seetadev
seetadev merged commit 5a4538b into ipld:master Jul 13, 2026
24 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.

Bug: tox (docs) CI Job fails due to invalid extras in tox.ini

2 participants