Skip to content

Commit

Permalink
[docs] Minor fixes
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
nemesifier committed Aug 30, 2024
1 parent dcd828d commit 904e168
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 12 deletions.
8 changes: 5 additions & 3 deletions docs/developer/extending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -202,9 +202,11 @@ Then, run the migrations:
./manage.py migrate
**Note**: the ``0004_default_groups`` is required because other OpenWISP
modules depend on it. If it's not created as documented here, the
migrations of other OpenWISP modules will fail.
.. note::

The ``0004_default_groups`` is required because other OpenWISP
modules depend on it. If it's not created as documented here, the
migrations of other OpenWISP modules will fail.

10. Create the admin
--------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/developer/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Developer Docs

Other useful resources:

- :doc:`../user/rest-api`
- :doc:`../user/settings`
- :doc:`../user/rest-api`
- :doc:`../user/settings`
4 changes: 2 additions & 2 deletions docs/user/basic-concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,8 @@ via the administrative interface, even if they are flagged as Staff users.
They can only consume REST API endpoints or other non administrative user
interface pages.

A real-world example of this is the `User API endpoints of OpenWISP RADIUS
<https://openwisp-radius.readthedocs.io/en/stable/user/api.html#user-api-endpoints>`_,
A real-world example of this is the :ref:`User API endpoints of OpenWISP RADIUS
<radius_user_api_endpoints>`,
which allow users to sign up to an organization, verify their phone number
by receiving a verification code via SMS, see their RADIUS sessions, etc.
All those endpoints are tied to an organization because different
Expand Down
4 changes: 2 additions & 2 deletions docs/user/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ of Django third party apps to implement the following:
like OAuth, SAML, MS Azure Authentication, etc.
- Support multi-factor authentication (MFA).

On a similar note, the `OpenWISP RADIUS
<https://openwisp-radius.readthedocs.io/>`_ module ships logic that allows
On a similar note, the :doc:`OpenWISP RADIUS
</radius/index>` module ships logic that allows
end-users to log into WiFi services using OAuth (e.g.: social login
provided by Google, Facebook) or SAML (e.g.: `EIDAS
<https://www.eid.as/>`_, `SPID <https://www.spid.gov.it/en/>`_).
8 changes: 5 additions & 3 deletions docs/user/rest-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -259,9 +259,11 @@ Create User
POST /api/v1/users/user/
**Note**: Passing ``true`` to the optional ``is_verified`` field allows
creating users with their email address flagged as verified. This will
also skip sending the verification link to their email address.
.. note::

Passing ``true`` to the optional ``is_verified`` field allows
creating users with their email address flagged as verified. This will
also skip sending the verification link to their email address.

Get User Detail
~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 904e168

Please sign in to comment.