mirror of
https://github.com/podman-container-tools/podman.git
synced 2026-08-05 00:15:44 +00:00
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>
(cherry picked from commit c2ffe88ce0)
Signed-off-by: Paul Holzinger <pholzing@redhat.com>
32 lines
776 B
YAML
32 lines
776 B
YAML
# Read the Docs configuration file
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
# Required
|
|
version: 2
|
|
|
|
# Set the version of Python and other tools you might need
|
|
build:
|
|
os: ubuntu-26.04
|
|
tools:
|
|
python: "3.14"
|
|
golang: "1.25"
|
|
jobs:
|
|
pre_build:
|
|
- make swagger
|
|
- mv pkg/api/swagger.yaml docs/source/_static/swagger.yaml
|
|
|
|
# Build documentation in the docs/ directory with Sphinx
|
|
sphinx:
|
|
configuration: docs/source/conf.py
|
|
|
|
# Optionally build your docs in additional formats
|
|
formats:
|
|
- htmlzip
|
|
- epub
|
|
- pdf
|
|
|
|
# We recommend specifying your dependencies to enable reproducible builds:
|
|
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
|
|
python:
|
|
install:
|
|
- requirements: docs/requirements.txt
|