diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1b2bac83b..106eb446f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -46,9 +46,9 @@ jobs: exit $(tail -n 1 build-output-warnings.txt | awk '{print $2}') - name: Deploy if: github.event_name == 'push' && github.ref == 'refs/heads/development' - uses: JamesIves/github-pages-deploy-action@releases/v3 + uses: JamesIves/github-pages-deploy-action@releases/v4 with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - BRANCH: gh-pages - FOLDER: ${{runner.workspace}}/build-docs/sphinx/html - SINGLE_COMMIT: true + token: ${{ secrets.GITHUB_TOKEN }} + branch: gh-pages + folder: ${{runner.workspace}}/build-docs/sphinx/html + single-commit: true diff --git a/Docs/sphinx/GettingStarted.rst b/Docs/sphinx/GettingStarted.rst index 59d406466..e46aba7eb 100644 --- a/Docs/sphinx/GettingStarted.rst +++ b/Docs/sphinx/GettingStarted.rst @@ -4,7 +4,7 @@ `PelePhysics` Quickstart ************************ -Greetings impatient user. As a word of caution, this documentation is in progress. Some parts of the code remain undocumented, +Greetings users. As a word of caution, this documentation is in progress. Some parts of the code remain undocumented, and some parts of the documentation are out of data. If you are confused by something you read here, or otherwise need help with `PelePhysics`, the best course of action is to open a Discussion on the `GitHub page `_, so the development team and other users can help.