From f06db0ac6cfe605687d08e7790c13a4104634f10 Mon Sep 17 00:00:00 2001 From: Jeong YunWon Date: Fri, 29 Jun 2018 20:54:05 +0900 Subject: [PATCH] Fix doc reference --- docs/extend.rst | 3 ++- docs/factory.rst | 2 ++ docs/why.rst | 16 ++++++++-------- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/extend.rst b/docs/extend.rst index 0d8c97b..548b451 100644 --- a/docs/extend.rst +++ b/docs/extend.rst @@ -29,7 +29,7 @@ General factory: :func:`ring.func.base.factory` Creating simple shortcuts +++++++++++++++++++++++++ -:see: :doc:`factory` for creating shortcuts of existing factories. +:see: :ref:`factory.shortcut` to create shortcuts of existing factories. New storage interface @@ -46,3 +46,4 @@ New sub-function semantics ++++++++++++++++++++++++++ + diff --git a/docs/factory.rst b/docs/factory.rst index 6e322e8..29cb7fe 100644 --- a/docs/factory.rst +++ b/docs/factory.rst @@ -66,6 +66,8 @@ Common factory parameters :see: :func:`ring.func.base.factory` for generic factory definition. +.. _factory.shortcut: + Creating factory shortcuts -------------------------- diff --git a/docs/why.rst b/docs/why.rst index b11e0c3..078cf89 100644 --- a/docs/why.rst +++ b/docs/why.rst @@ -105,7 +105,7 @@ turns into a storage approach which we demonstrated at first section. You can control them at a consistent level with **Ring**. -:see: :ref:`lifecycle` section for details. +:see: :ref:`why.lifecycle` section for details. :see: :func:`ring.django.cache_page` which exactly solved the problem. @@ -120,7 +120,7 @@ to drop the provided feature but to implement a new one. You can replace semantics of **Ring** commands and storage behaviors. -:see: :ref:`strategy` section for details. +:see: :ref:`why.strategy` section for details. Hidden backend @@ -136,7 +136,7 @@ Python world. :class:`ring.ring_base.Ring` and low-level storage interfaces are straightforward and smooth. -:see: :ref:`transparency` section for details. +:see: :ref:`why.transparency` section for details. Data encoding @@ -175,10 +175,10 @@ time. *Ring* has a configurable data-coding layer. Users can replace it by functions, by their needs and by injecting code. -:see: :ref:`datacoding` section for details. +:see: :ref:`why.datacoding` section for details. -.. _lifecycle: +.. _why.lifecycle: Ring controls cache life-cycle with sub-functions ------------------------------------------------- @@ -226,7 +226,7 @@ Function parameters are also supported in an expected manner: cached_function.delete(10, 20, 30) # delete call -.. _transparency: +.. _why.transparency: Ring approaches backend transparent way --------------------------------------- @@ -252,7 +252,7 @@ the backends. Various storages have their own features by their design. :see: :doc:`control` for details. -.. _datacoding: +.. _why.datacoding: Ring provides a configurable data-coding layer ---------------------------------------------- @@ -277,7 +277,7 @@ with `pylibmc`. Of course for other backends too. ``my_cache = functools.partial(ring.memcache, client, coder='pickle')``. -.. _strategy: +.. _why.strategy: Ring comes with configurable commands and storage actions ---------------------------------------------------------