Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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]
Expand Down
Loading