diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml index 81077df0..6e54be82 100644 --- a/.github/workflows/build-docs.yaml +++ b/.github/workflows/build-docs.yaml @@ -12,10 +12,17 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - uses: ammaraskar/sphinx-action@master + + - uses: actions/setup-python@v5 with: - docs-folder: "./" - build-command: "sphinx-build -n -W --keep-going -b html -d _build/doctrees . _build/html" + python-version: '3.12' + + - name: Install Python requirements + run: pip install -r requirements.txt + + - name: Sphinx Build + run: sphinx-build -n -W --keep-going -b html -d _build/doctrees . _build/html + - uses: actions/upload-artifact@v1 with: name: DocumentationHTML diff --git a/.readthedocs.yaml b/.readthedocs.yaml index ac57d362..04889a17 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,5 +5,9 @@ build: tools: python: "3.12" +python: + install: + - requirements: requirements.txt + sphinx: configuration: conf.py diff --git a/cookbook/securing-your-application.rst b/cookbook/securing-your-application.rst index 6b82aadc..77ecafd0 100644 --- a/cookbook/securing-your-application.rst +++ b/cookbook/securing-your-application.rst @@ -171,7 +171,7 @@ needs some updating. You can add the permission tab as shown below: ->createFormViewBuilder('sulu_example.edit_form.permissions', '/permissions') ->setResourceKey('permissions') ->setFormKey('permission_details') - ->setRequestParameters(['resourceKey' => 'example']) + ->addRequestParameters(['resourceKey' => 'example']) ->setTabCondition('_permissions.security') ->setTabTitle('sulu_security.permissions') ->addToolbarActions([new ToolbarAction('sulu_admin.save')]) @@ -180,7 +180,7 @@ needs some updating. You can add the permission tab as shown below: } } -The important option here is set in the ``setRequestParameters`` call, which +The important option here is set in the ``addRequestParameters`` call, which defines for which resource this permission form is used. In order for that to work the relation between the ``resourceKey`` and the security context and the security class has to be configured: diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..480f0fbb --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +setuptools==68.2.2 +sphinx==7.2.6