From 7e6a0b84a44f2f35a6c59a1340335015fb9a5add Mon Sep 17 00:00:00 2001 From: Shengyu Zhang Date: Sun, 4 Dec 2022 22:45:34 +0800 Subject: [PATCH] docs: Move beta warning ahead --- README.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index aa71f7b..7639ae0 100644 --- a/README.rst +++ b/README.rst @@ -7,15 +7,14 @@ Sphinx to GitHub Pages V3 Help you deploying your Sphinx documentation to Github Pages. +.. warning:: v3 is **in beta and subject to change**, use v2__ if you need a stable version. + +__ https://github.com/sphinx-notes/pages/tree/v2 + Usage ===== 1. `Set the publishing sources to "Github Actions"`__ - - .. note:: Publishing your GitHub Pages site with GitHub Actions workflow is **in beta and subject to change**. - - __ https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow - 2. Create workflow: .. code-block:: yaml @@ -40,6 +39,9 @@ Usage - id: deployment uses: sphinx-notes/pages@v3 + +__ https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow + Inputs ======