diff --git a/docs/developer/extending.rst b/docs/developer/extending.rst index b2eef312..0af46653 100644 --- a/docs/developer/extending.rst +++ b/docs/developer/extending.rst @@ -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 -------------------- diff --git a/docs/developer/index.rst b/docs/developer/index.rst index dcc5b8ea..7246415d 100644 --- a/docs/developer/index.rst +++ b/docs/developer/index.rst @@ -14,5 +14,5 @@ Developer Docs Other useful resources: - - :doc:`../user/rest-api` - - :doc:`../user/settings` +- :doc:`../user/rest-api` +- :doc:`../user/settings` diff --git a/docs/user/basic-concepts.rst b/docs/user/basic-concepts.rst index 527ab712..5e90c730 100644 --- a/docs/user/basic-concepts.rst +++ b/docs/user/basic-concepts.rst @@ -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 -`_, +A real-world example of this is the :ref:`User API endpoints of OpenWISP RADIUS +`, 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 diff --git a/docs/user/intro.rst b/docs/user/intro.rst index 4b882a4f..720a7a17 100644 --- a/docs/user/intro.rst +++ b/docs/user/intro.rst @@ -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 -`_ module ships logic that allows +On a similar note, the :doc:`OpenWISP RADIUS +` 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 `_, `SPID `_). diff --git a/docs/user/rest-api.rst b/docs/user/rest-api.rst index ca86b2b6..8839a9b6 100644 --- a/docs/user/rest-api.rst +++ b/docs/user/rest-api.rst @@ -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 ~~~~~~~~~~~~~~~