Skip to content

Commit

Permalink
Merge branch '2.4' of github.com:sulu/sulu-docs into 2.5
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-schranz committed Apr 30, 2024
2 parents d192b50 + 713e116 commit 0c48749
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 5 deletions.
13 changes: 10 additions & 3 deletions .github/workflows/build-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,9 @@ build:
tools:
python: "3.12"

python:
install:
- requirements: requirements.txt

sphinx:
configuration: conf.py
4 changes: 2 additions & 2 deletions cookbook/securing-your-application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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')])
Expand All @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
setuptools==68.2.2
sphinx==7.2.6

0 comments on commit 0c48749

Please sign in to comment.