From 89e1a3a935c68403894b442ecdbcfb385a8e9596 Mon Sep 17 00:00:00 2001 From: MobyNL Date: Tue, 18 Aug 2026 21:29:42 +0200 Subject: [PATCH] docs: link to the versioned documentation index The README and the package metadata pointed at /MitmLibraryKeywords.html, which is only written when a release is published. Until the first release under the new workflow that path does not exist, so both links answered 404 - and the site index, which does exist and lists every published version, was linked only as an afterthought. They now point at the index, which is the entry point and is valid whether or not a release has been published yet. The direct links to the latest release and to the current main stay, below it. The bare path keeps being published on release, because the metadata of every already published version points at it, back to 0.1. Nothing in the repository links there any more, but those releases cannot be changed. Co-Authored-By: Claude Opus 5 --- .github/workflows/docs.yml | 5 +++-- README.md | 15 +++++++-------- pyproject.toml | 4 ++-- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b88fd2f..293feb4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -79,8 +79,9 @@ jobs: cp MitmLibraryKeywords.html "site/${path}/MitmLibraryKeywords.html" if [ "${{ steps.target.outputs.release }}" = "true" ]; then - # The bare path is what pyproject.toml, the README and the metadata of every - # already published release point at, so it stays as the newest release. + # The bare path is what the metadata of every already published release + # points at, back to 0.1. Nothing in the repository links to it any more, + # but those releases cannot be changed, so it stays as the newest release. cp MitmLibraryKeywords.html site/MitmLibraryKeywords.html mkdir -p site/latest cp MitmLibraryKeywords.html site/latest/MitmLibraryKeywords.html diff --git a/README.md b/README.md index c5906b0..5285878 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ ![MitmLibrary Icon](https://github.com/MobyNL/robotframework-mitmlibrary/blob/main/MITMLibrary_small.png) -## Keyword -[Keyword documentation](https://mobynl.github.io/robotframework-mitmlibrary/MitmLibraryKeywords.html) +## Keyword documentation +[Keyword documentation](https://mobynl.github.io/robotframework-mitmlibrary/), published per version. ## Overview @@ -177,14 +177,13 @@ mitm. Follow the guide on the ## Documentation -The [keyword documentation](https://mobynl.github.io/robotframework-mitmlibrary/MitmLibraryKeywords.html) -describes every keyword, its arguments and examples. - -It is published per version, so you can read the documentation for the version you -actually have installed rather than for whatever is newest: +The [keyword documentation](https://mobynl.github.io/robotframework-mitmlibrary/) describes +every keyword, its arguments and examples. It is published per version, so you can read the +documentation for the version you actually have installed rather than for whatever is +newest: +- [all versions](https://mobynl.github.io/robotframework-mitmlibrary/) — start here - [latest release](https://mobynl.github.io/robotframework-mitmlibrary/latest/MitmLibraryKeywords.html) -- [all versions](https://mobynl.github.io/robotframework-mitmlibrary/) - [current main, unreleased](https://mobynl.github.io/robotframework-mitmlibrary/dev/MitmLibraryKeywords.html) ## API stability diff --git a/pyproject.toml b/pyproject.toml index c30306a..fc2743f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ license = "MIT" readme = "README.md" homepage = "https://github.com/MobyNL/robotframework-mitmlibrary" repository = "https://github.com/MobyNL/robotframework-mitmlibrary" -documentation = "https://mobynl.github.io/robotframework-mitmlibrary/MitmLibraryKeywords.html" +documentation = "https://mobynl.github.io/robotframework-mitmlibrary/" packages = [{ include = "MitmLibrary" }] keywords = [ "robotframework", @@ -29,7 +29,7 @@ classifiers = [ ] [tool.poetry.urls] -"Keyword documentation" = "https://mobynl.github.io/robotframework-mitmlibrary/MitmLibraryKeywords.html" +"Keyword documentation" = "https://mobynl.github.io/robotframework-mitmlibrary/" "Slack Channel" = "https://robotframework.slack.com/archives/C06M2J3J8AC" [tool.poetry.dependencies]