From 0fd3cfb665f3cd5c5cd90797e25d38feaf5b1204 Mon Sep 17 00:00:00 2001 From: pancho horrillo Date: Wed, 11 Dec 2019 17:44:10 +0100 Subject: [PATCH] doc: add internal links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Roberto Abdelkader Martínez Pérez --- docs/source/concepts/route_matching.rst | 2 +- docs/source/concepts/routes.rst | 2 ++ docs/source/index.rst | 20 +++++++++++--------- docs/source/the_project/quickstart.rst | 2 ++ 4 files changed, 16 insertions(+), 10 deletions(-) diff --git a/docs/source/concepts/route_matching.rst b/docs/source/concepts/route_matching.rst index bd1e9c7..d3eebb9 100644 --- a/docs/source/concepts/route_matching.rst +++ b/docs/source/concepts/route_matching.rst @@ -1,7 +1,7 @@ Route Matching ============== -*Kapow!* maintains a route table with a list of routes as provided by the user, +*Kapow!* maintains a :ref:`route ` table with a list of routes as provided by the user, and uses it to determine which handler should an incoming request be dispatched to. diff --git a/docs/source/concepts/routes.rst b/docs/source/concepts/routes.rst index daa9a62..dcdfac8 100644 --- a/docs/source/concepts/routes.rst +++ b/docs/source/concepts/routes.rst @@ -1,3 +1,5 @@ +.. _routes: + Routes ====== diff --git a/docs/source/index.rst b/docs/source/index.rst index 2204858..62000bc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -25,30 +25,27 @@ What's *Kapow!* :align: center Want to know more? - Check the :doc:`the_project/quickstart` section for a longer explanation of - what *Kapow!* does. + Check the :ref:`Quick Start Guide ` section for a longer + explanation of what *Kapow!* does. Authors ======= - *Kapow!* is being developed by the - `BBVA-Labs Security team `_. + *Kapow!* is being developed by the `BBVA-Labs Security team`_. License ======= - *Kapow!* is Open Source Software and available under the - `Apache 2 license `_. + *Kapow!* is Open Source Software and available under the `Apache 2 license`_. Contributions ============= - Contributions are of course welcome. See - `CONTRIBUTING `_ - or skim existing tickets to see where you could help out. + Contributions are of course welcome. See `CONTRIBUTING`_ or skim `existing + tickets`_ to see where you could help out. Table of Contents @@ -97,3 +94,8 @@ Indices and Tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +.. _BBVA-Labs Security team: https://github.com/BBVA/kapow/blob/master/AUTHORS.rst +.. _Apache 2 license: https://raw.githubusercontent.com/BBVA/kapow/master/LICENSE +.. _CONTRIBUTING: https://github.com/BBVA/kapow/blob/master/CONTRIBUTING.rst +.. _existing tickets: https://github.com/BBVA/kapow/labels/good%20first%20issue diff --git a/docs/source/the_project/quickstart.rst b/docs/source/the_project/quickstart.rst index 9abbfde..fcfdcf6 100644 --- a/docs/source/the_project/quickstart.rst +++ b/docs/source/the_project/quickstart.rst @@ -1,3 +1,5 @@ +.. _quickstart: + Quick Start Guide =================