Commit Graph

21 Commits

Author SHA1 Message Date
Paul Holzinger
c2ffe88ce0 build the swagger.yml on readthedocs
One problem with the swagger upload is we need an extra bucket and then
we need our own custom version schema and selector on the website. If we
can just embed the swagger.yml as part of the official build we can get
rid of all of that and have a much simpler way as the regular
readthedocs version selector will work.

We also no longer need to maintain an extra bucket upload and no longer
need to update the version list which was forgotten all the time.

Fixes: #28827

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2026-06-23 19:10:34 +02:00
Paul Holzinger
250c530055 Revert "docs: generate Reference version list from json file"
This reverts commit 858150288f.

In the next commit I add a custom build for the swagger yaml which adds
it as part of the main readthedocs build so we can use the default
version selector and drop our custom workarounds.

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2026-06-23 19:09:30 +02:00
Martin Fischer
858150288f docs: generate Reference version list from json file
Signed-off-by: Martin Fischer <martin@push-f.com>
2025-10-15 05:31:01 +02:00
Lewis Roy
fb3eaf0c87 [DOCS] Add missing stable swagger API links
Signed-off-by: Lewis Roy <lewis@redhat.com>
2025-10-03 06:05:09 +10:00
Paul Holzinger
79be095795 docs: add v5.4 to API reference
Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2025-02-11 14:05:00 +01:00
Paul Holzinger
e6e9d2c21c docs: add 5.3 as Reference version
Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2024-11-19 11:31:49 +01:00
Paul Holzinger
f4be5e34c2 docs: add missing swagger links for the stable branches
It is part of the release process yet everybody ignores this. I really
should look into automating this instead.

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2024-10-29 17:30:40 +01:00
Paul Holzinger
068ddfd19f update API doc version to 5.0.0
Also update the website to display the correct swagger doc for the right
version, the 5.0 swagger file will not exist until we branch but I added
it anyway so we do not forget it.

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2024-03-12 12:06:15 +01:00
Paul Holzinger
2168f07450 [CI:DOCS] update swagger version on docs.podman.io
Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2023-10-05 10:45:22 +02:00
Paul Holzinger
777b5efa4e [CI:DOCS] update API docs version list
Also update the RELEASE_PROCESS doc so maybe it will not be forgotten
next time.

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2023-09-13 17:07:14 +02:00
arctic-alpaca
1cac535062 Update API reference to include v4.5
Signed-off-by: arctic-alpaca <67190338+arctic-alpaca@users.noreply.github.com>
2023-04-17 14:52:36 +02:00
Ashley Cui
b6d91ebfb1 Update main to reflect v4.4.0 release
Update README, API reference and release notes for v4.4.0

Signed-off-by: Ashley Cui <acui@redhat.com>
2023-02-02 14:14:31 -05:00
Paul Holzinger
a141c9ac23 update api versions on docs.podman.io
Fixes #16300

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2022-10-26 14:56:58 +02:00
Matthew Heon
0dbfd376ff Add 4.1 branch to API documentation
Signed-off-by: Matthew Heon <matthew.heon@pm.me>
2022-05-06 15:05:03 +02:00
Paul Holzinger
829f88d74d Show API doc for several versions
Right now it is not possible to look at the API version for a specific
version. docs.podman.io always show the latest version from the main
branch. This is not want many users want so they now have the ability to
select a different version.

Fixes #12796

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2022-02-09 18:17:52 +01:00
Scott McCarty
176f38c25b [CI:DOCS] Docs revamp.
* Rewrote the Home and Introduction pages.
* Created a dedicated Search page
* Rewrote the Tutorials page to have native links in RTD/Shpinx
* Added iframe to Reference page to display API reference docs inline

Signed-off-by: Scott McCarty <scott.mccarty@gmail.com>
2020-05-21 17:16:10 -04:00
Brent Baude
f432999023 [CI:DOCS] Add logo and dev statement
Add statement to the info section stating this is experimental only for now.  Also add the podman logo to the right-hand navigation.

Signed-off-by: Brent Baude <bbaude@redhat.com>
2020-01-20 13:59:55 -06:00
baude
47f9a63574 [CI:DOCS]static files end up in _static on rtd
Signed-off-by: baude <bbaude@redhat.com>
2020-01-17 16:13:30 -06:00
baude
9ea2024c55 [CI:DOCS] Correct link syntax
Signed-off-by: baude <bbaude@redhat.com>
2020-01-17 15:50:36 -06:00
baude
cc0f7defdc [CI:DOCS]Connect API docs and RTD
Signed-off-by: baude <bbaude@redhat.com>
2020-01-17 15:12:35 -06:00
baude
52b92023ed Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier.  man
pages now exist in docs/source/man and the sphinx make files exists in
docs.

Signed-off-by: baude <bbaude@redhat.com>
2019-10-31 12:31:39 -05:00