summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-01-17 22:26:56 +0100
committerGitHub <noreply@github.com>2020-01-17 22:26:56 +0100
commit37ec23b462b74eadf19802741e926570191f1085 (patch)
tree4c4a7b8f0890e8c33db9c145407dda77e1e58e8e
parent3b6a843eb2942ec4093072f4a6468a57f19de5cb (diff)
parentcc0f7defdc72becc9bb306e82be0b0d50ed87078 (diff)
downloadpodman-37ec23b462b74eadf19802741e926570191f1085.tar.gz
podman-37ec23b462b74eadf19802741e926570191f1085.tar.bz2
podman-37ec23b462b74eadf19802741e926570191f1085.zip
Merge pull request #4896 from baude/rtdapi
[CI:DOCS]Connect API docs and RTD
-rwxr-xr-xcontrib/cirrus/upload_release_archive.sh4
-rw-r--r--docs/source/Reference.rst2
-rw-r--r--docs/source/_static/api.html24
3 files changed, 28 insertions, 2 deletions
diff --git a/contrib/cirrus/upload_release_archive.sh b/contrib/cirrus/upload_release_archive.sh
index 2716c402c..a94a5cc82 100755
--- a/contrib/cirrus/upload_release_archive.sh
+++ b/contrib/cirrus/upload_release_archive.sh
@@ -19,8 +19,8 @@ then
BUCKET="libpod-pr-releases"
elif [[ -n "$CIRRUS_BRANCH" ]]
then
- # Only release non-development tagged commit ranges
- if is_release
+ # Only release binaries for tagged commit ranges, unless working on docs
+ if is_release || [[ $CIRRUS_TASK_NAME =~ "docs" ]]
then
PR_OR_BRANCH="$CIRRUS_BRANCH"
BUCKET="libpod-$CIRRUS_BRANCH-releases"
diff --git a/docs/source/Reference.rst b/docs/source/Reference.rst
index 9a771c87f..9933b0fbf 100644
--- a/docs/source/Reference.rst
+++ b/docs/source/Reference.rst
@@ -1,2 +1,4 @@
Reference
=========
+
+Check out our new [API documentation](api.html) \ No newline at end of file
diff --git a/docs/source/_static/api.html b/docs/source/_static/api.html
new file mode 100644
index 000000000..08f55b620
--- /dev/null
+++ b/docs/source/_static/api.html
@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>ReDoc</title>
+ <!-- needed for adaptive design -->
+ <meta charset="utf-8"/>
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+
+ <!--
+ ReDoc doesn't change outer page styles
+ -->
+ <style>
+ body {
+ margin: 0;
+ padding: 0;
+ }
+ </style>
+ </head>
+ <body>
+ <redoc spec-url='https://storage.googleapis.com/libpod-master-releases/swagger-latest-master.yaml'></redoc>
+ <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
+ </body>
+</html>