Skip to content

Commit

Permalink
Fix doc reference
Browse files Browse the repository at this point in the history
  • Loading branch information
youknowone committed Jun 29, 2018
1 parent 7936a88 commit f06db0a
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
3 changes: 2 additions & 1 deletion docs/extend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -46,3 +46,4 @@ New sub-function semantics
++++++++++++++++++++++++++



2 changes: 2 additions & 0 deletions docs/factory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ Common factory parameters
:see: :func:`ring.func.base.factory` for generic factory definition.


.. _factory.shortcut:

Creating factory shortcuts
--------------------------

Expand Down
16 changes: 8 additions & 8 deletions docs/why.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
-------------------------------------------------
Expand Down Expand Up @@ -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
---------------------------------------
Expand All @@ -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
----------------------------------------------
Expand All @@ -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
---------------------------------------------------------
Expand Down

0 comments on commit f06db0a

Please sign in to comment.