diff --git a/docs/conf.py b/docs/conf.py index 632063e58..605d9f07c 100644 --- a/docs/conf.py +++ b/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)} diff --git a/docs/how.rst b/docs/how.rst index a1e76ae4e..911e6ff5d 100644 --- a/docs/how.rst +++ b/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 ................... diff --git a/docs/index.rst b/docs/index.rst index 46051d0b4..0078a9323 100644 --- a/docs/index.rst +++ b/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 `_ + :ref:`double check their clock synchronisation ` #. If you modify data outside Django – typically after restoring a SQL database –, - use the :ref:`manage.py command `_ -#. Be aware of :ref:`the few other limits `_ + use the :ref:`manage.py command ` +#. Be aware of :ref:`the few other limits ` #. If you use `django-debug-toolbar `_, you can add ``'cachalot.panels.CachalotPanel',`` to your ``DEBUG_TOOLBAR_PANELS`` #. Enjoy! -Note: In settings, you can use `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). +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 `_ +Why use cachalot? :ref:`Check out our comparison ` Below the tree is an in-depth opinion from the new maintainer: diff --git a/docs/introduction.rst b/docs/introduction.rst index 3d255c5f6..fe4de2a5b 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -48,7 +48,7 @@ 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 `. +- An easy control thanks to :ref:`settings` and :ref:`a simple 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 @@ -56,6 +56,8 @@ Features (including bulk changes) and :ref:`a template tag for a better template fragment caching