Build release docs with local package
Nobody has claimed this yet.
- Dominant language
- Jinja
- Stars
- 2
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
Currently, we first publish a package to PyPI and then use that to build the docs for a release. This has the disadvantage that the workflow needs to wait for the package to become available. This not only takes some time and has the potential to time out but it also limits parallelism. But it has the advantage that it tests whether the package was actually published.
However, I think that the last point is not relevant as it effectively tests the 3rd party publish action that we use.
Instead, for our Python-only packages, we can buld the docs wither with a wheel that was uploaded as an artefact or simply from source. Building a wheel only takes a few seconds.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the release workflow that publishes the package to PyPI and then builds the release documentation. Compare building the docs from the uploaded wheel or directly from source, and verify that the workflow no longer waits for PyPI while still completing the documentation build successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation, release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100