TopoToolbox / TopoToolbox/pytopotoolbox

Publish docs for released versions and latest version

Open
#331 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

build documentation
Dominant language
Python
Stars
26
Forks
19
PR merge metrics
No merged PRs in 30d

Description

Changes that we make to pytopotoolbox are visible in the documentation before they become available in the packages users will install from PyPI (#330). We should version the documentation and display the latest PyPI release by default.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the documentation publishing configuration and the PyPI release workflow to understand how documentation is currently built and deployed. Define how released versions will be retained and how the latest PyPI release becomes the default, then verify the published documentation against the available package versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.