Skip to content

Commit

Permalink
[docs] Improved references
Browse files Browse the repository at this point in the history
  • Loading branch information
pandafy committed Jun 6, 2024
1 parent bf92417 commit 85a4471
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 21 deletions.
20 changes: 10 additions & 10 deletions docs/developer/extending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Add ``openwisp_utils.loaders.DependencyLoader`` to ``TEMPLATES`` in your
}
]
6. Inherit the AppConfig class
6. Inherit the AppConfig Class
------------------------------

Please refer to the following files in the sample app of the test project:
Expand All @@ -155,7 +155,7 @@ For more information regarding the concept of ``AppConfig`` please refer
to the `"Applications" section in the django documentation
<https://docs.djangoproject.com/en/dev/ref/applications/>`_.

7. Create your custom models
7. Create your Custom Models
----------------------------

For the purpose of showing an example, we added a simple "details" field
Expand All @@ -168,7 +168,7 @@ You can add fields in a similar way in your ``models.py`` file.
refer to the `"Models" section in the django documentation
<https://docs.djangoproject.com/en/dev/topics/db/models/>`_.

8. Add swapper configurations
8. Add Swapper Configurations
-----------------------------

Once you have created the models, add the following to your
Expand All @@ -182,7 +182,7 @@ Once you have created the models, add the following to your
Substitute ``myipam`` with the name you chose in step 1.

9. Create database migrations
9. Create Database Migrations
-----------------------------

Create and apply database migrations:
Expand All @@ -196,7 +196,7 @@ For more information, refer to the `"Migrations" section in the django
documentation
<https://docs.djangoproject.com/en/dev/topics/migrations/>`_.

10. Create the admin
10. Create the Admin
--------------------

Refer to the `admin.py file of the sample app
Expand All @@ -210,7 +210,7 @@ how it can be customized, please refer to `"The django admin site" section
in the django documentation
<https://docs.djangoproject.com/en/dev/ref/contrib/admin/>`_.

1. Monkey patching
1. Monkey Patching
~~~~~~~~~~~~~~~~~~

If the changes you need to add are relatively small, you can resort to
Expand All @@ -224,7 +224,7 @@ For example:
SubnetAdmin.app_label = "sample_ipam"
2. Inheriting admin classes
2. Inheriting Admin Classes
~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you need to introduce significant changes and/or you don't want to
Expand Down Expand Up @@ -259,7 +259,7 @@ resort to monkey patching, you can proceed as follows:
Substitute ``myipam`` with the name you chose in step 1.

11. Create root URL configuration
11. Create Root URL Configuration
---------------------------------

.. code-block:: python
Expand All @@ -278,7 +278,7 @@ For more information about URL configuration in django, please refer to
the `"URL dispatcher" section in the django documentation
<https://docs.djangoproject.com/en/dev/topics/http/urls/>`_.

12. Import the automated tests
12. Import the Automated Tests
------------------------------

When developing a custom application based on this module, it's a good
Expand Down Expand Up @@ -306,7 +306,7 @@ For more information about automated tests in django, please refer to
`"Testing in Django"
<https://docs.djangoproject.com/en/dev/topics/testing/>`_.

Other base classes that can be inherited and extended
Other Base Classes That Can be Inherited and Extended
-----------------------------------------------------

The following steps are not required and are intended for more advanced
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ Alternatively you can use the git protocol:

.. code-block:: shell
pip install -e git+git://github.com/openwisp/openwisp-ipam#egg=openwisp_users
pip install -e git+git://github.com/openwisp/openwisp-ipam#egg=openwisp_ipam
1 change: 1 addition & 0 deletions docs/user/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ OpenWISP IPAM provides the following capabilities:
- :doc:`REST API <rest-api>` for CRUD operations and main features
- Possibility to search for an IP or subnet
- Visual display for a specific subnet

.. image:: https://raw.githubusercontent.com/openwisp/openwisp-ipam/docs/docs/visual-display.png
:target: https://raw.githubusercontent.com/openwisp/openwisp-ipam/docs/docs/visual-display.png
14 changes: 5 additions & 9 deletions docs/user/rest-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ REST API

.. _ipam_live_documentation:

Live documentation
Live Documentation
------------------

.. image:: https://raw.githubusercontent.com/openwisp/openwisp-ipam/docs/docs/api-docs.png
Expand All @@ -14,7 +14,7 @@ available at ``/api/v1/docs/``.

.. _ipam_browsable_web_interface:

Browsable web interface
Browsable Web Interface
-----------------------

.. image:: https://raw.githubusercontent.com/openwisp/openwisp-ipam/docs/docs/api-ui.png
Expand All @@ -29,8 +29,7 @@ makes it even easier to find out the details of each endpoint.
Authentication
--------------

See openwisp-users: `authenticating with the user token
<https://github.com/openwisp/openwisp-users#authenticating-with-the-user-token>`_.
See openwisp-users: :ref:`authenticating_rest_api`.

When browsing the API via the :ref:`ipam_live_documentation` or the
:ref:`ipam_browsable_web_interface`, you can also use the session
Expand All @@ -49,7 +48,7 @@ paginating the results in conjunction with the ``page`` parameter.
.. _ipam_list_endpoints:

List of endpoints
List of Endpoints
-----------------

Since the detailed explanation is contained in the
Expand Down Expand Up @@ -78,10 +77,7 @@ The rate descriptions used in ``DEFAULT_THROTTLE_RATES`` may include
Get Next Available IP
---------------------

A model method to fetch the next available IP address under a specific
subnet. This method can also be accessed via a REST API:
`openwisp_ipam/base/models.py
<https://github.com/openwisp/openwisp-ipam/tree/master/tests/openwisp2/openwisp_ipam/base/models.py#L80>`_
Fetch the next available IP address under a specific subnet.

GET
~~~
Expand Down
1 change: 0 additions & 1 deletion docs/user/settings.rst

This file was deleted.

0 comments on commit 85a4471

Please sign in to comment.