Skip to content

Commit

Permalink
Sphinx Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sam-bertin committed Jul 9, 2024
1 parent 4248a39 commit 99244ad
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 4 deletions.
Binary file added docs/images/authorization_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/authorization_matrix.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/export_matrix.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/export_matrix_format.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 7 additions & 4 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,28 @@ Add the URL to your Django project's ``urls.py``:
# Display the Authorization Matrix

Navigate to the Groups admin page and click on the "Authorization Matrix" link to view the matrix.

.. image:: images/authorization_matrix.png
:alt: Authorization Matrix

Navigate to the Groups admin page and click on the "Authorization Matrix" link to view the matrix.

.. image:: images/authorization_button.png
:alt: Show Authorization Matrix Button

# Export the Authorization Matrix

On the top right corner of the Groups admin page, you can choose to export the matrix to different formats.

Click the EXPORT button and chose the format you want to export the matrix to.

.. image:: images/export_matrix.png
:alt: Export Matrix
:alt: Export Authorization Matrix Button

You can pick between two resources:
- UserGroupResource : exports the matrix with users as rows and groups as columns
- GroupPermissionsResource : exports the matrix with permissions as rows and groups as columns

.. image:: images/export_matrix_format.png
:alt: Export Matrix Format
:alt: Export Authorization Matrix Formats


0 comments on commit 99244ad

Please sign in to comment.