Docs: Updated sphinx & links clean up

docs/conf.py

@@ -271,6 +271,5 @@
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
 
-
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

docs/how.rst

@@ -1,7 +1,8 @@
 How django-cachalot works
 -------------------------
 
-.. note:: If you don’t understand, you can pretend it’s magic.
+.. note::
+	If you don’t understand, you can pretend it’s magic.
 
 Reverse engineering
 ...................

docs/index.rst

@@ -29,20 +29,20 @@ Usage
 #. ``pip install django-cachalot``
 #. Add ``'cachalot',`` to your ``INSTALLED_APPS``
 #. If you use multiple servers with a common cache server,
-   :ref:`double check their clock synchronisation <https://django-cachalot.readthedocs.io/en/latest/limits.html#multiple-servers>`_
+   :ref:`double check their clock synchronisation <Multiple servers>`
 #. If you modify data outside Django
    – typically after restoring a SQL database –,
-   use the :ref:`manage.py command <https://django-cachalot.readthedocs.io/en/latest/quickstart.html#command>`_
-#. Be aware of :ref:`the few other limits <https://django-cachalot.readthedocs.io/en/latest/limits.html#limits>`_
+   use the :ref:`manage.py command <Command>`
+#. Be aware of :ref:`the few other limits <Limits>`
 #. If you use
    `django-debug-toolbar <https://github.com/jazzband/django-debug-toolbar>`_,
    you can add ``'cachalot.panels.CachalotPanel',``
    to your ``DEBUG_TOOLBAR_PANELS``
 #. Enjoy!
 
-Note: In settings, you can use `CACHALOT_UNCACHABLE_TABLES <https://django-cachalot.readthedocs.io/en/latest/quickstart.html#cachalot-only-cachable-tables>`_ as a frozenset of table names (e.g. "public_test" if public was the app name and test is a model name).
+Note: In settings, you can use :ref:`CACHALOT_UNCACHABLE_TABLES` as a frozenset of table names (e.g. "public_test" if public was the app name and test is a model name).
 
-Why use cachalot? `Check out our comparison <https://django-cachalot.readthedocs.io/en/latest/introduction.html#comparison-with-similar-tools>`_
+Why use cachalot? :ref:`Check out our comparison <Comparison with similar tools>`
 
 Below the tree is an in-depth opinion from the new maintainer:
 

docs/introduction.rst

@@ -48,14 +48,16 @@ Features
   that per-object feature, they are unreliable and dangerous for your data.
 - **Handles everything in the ORM**. You can use the most advanced features
   from the ORM without a single issue, django-cachalot is extremely robust.
-- An easy control thanks to :ref:`settings` and :ref:`a simple API <API>`.
+- An easy control thanks to :ref:`settings` and :ref:`a simple API <Api>`.
   But that’s only required if you have a complex infrastructure.  Most people
   will never use settings or the API.
 - A few bonus features like
   :ref:`a signal triggered at each database change <Signal>`
   (including bulk changes) and
   :ref:`a template tag for a better template fragment caching <Template utils>`.
 
+.. _Comparison with similar tools:
+
 Comparison with similar tools
 .............................
 
@@ -64,9 +66,6 @@ to the other popular automatic ORM caches at the moment:
 `django-cache-machine <https://github.com/django-cache-machine/django-cache-machine>`_
 & `django-cacheops <https://github.com/Suor/django-cacheops>`_.
 
-Features
-~~~~~~~~
-
 ===================================================== ========= ============= ==========
 Feature                                               cachalot  cache-machine cacheops
 ===================================================== ========= ============= ==========

docs/limits.rst

@@ -103,7 +103,7 @@ in that query by comparing with models registered by Django.
 
 This is quite robust, so if a query is not invalidated automatically
 by this system, please :ref:`send a bug report <Reporting>`.
-In the meantime, you can use :ref:`the API <API>` to manually invalidate
+In the meantime, you can use :ref:`the API <Api>` to manually invalidate
 the tables where data has changed.
 
 However, this simple system can be too efficient in some very rare cases

docs/quickstart.rst

@@ -28,7 +28,7 @@ Usage
 #. ``pip install django-cachalot``
 #. Add ``'cachalot',`` to your ``INSTALLED_APPS``
 #. If you use multiple servers with a common cache server,
-   :ref:`double check their clock synchronisation <multiple servers>`
+   :ref:`double check their clock synchronisation <Multiple servers>`
 #. If you modify data outside Django
    – typically after restoring a SQL database –,
    use the :ref:`manage.py command <Command>`
@@ -61,7 +61,7 @@ Settings
 
   .. warning::
      After modifying this setting, you should invalidate the cache
-     :ref:`using the manage.py command <Command>` or :ref:`the API <API>`.
+     :ref:`using the manage.py command <Command>` or :ref:`the API <Api>`.
      Indeed, only the cache configured using this setting is automatically
      invalidated by django-cachalot – for optimisation reasons. So when you
      change this setting, you end up on a cache that may contain stale data.
@@ -197,7 +197,7 @@ Settings
               to use ``./manage.py invalidate_cachalot``).
 
 ``CACHALOT_FINAL_SQL_CHECK``
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 :Default: ``False``
 :Description:

docs/requirements.txt

@@ -1,2 +1,2 @@
-Sphinx==1.6.2
-sphinx-rtd-theme==0.2.4
+Sphinx==6.2.1
+sphinx-rtd-theme==1.2.2