Skip to content

Commit

Permalink
docs: Move beta warning ahead
Browse files Browse the repository at this point in the history
  • Loading branch information
SilverRainZ committed Dec 4, 2022
1 parent cb9ee3e commit 7e6a0b8
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
======

Expand Down

0 comments on commit 7e6a0b8

Please sign in to comment.