From e569b39e8c238579a08e3b998228e29416356435 Mon Sep 17 00:00:00 2001
From: Antoine Lambert <antoine.lambert@inria.fr>
Date: Tue, 23 Jan 2018 17:30:01 +0100
Subject: [PATCH] docs: Small fixes
---
docs/developers-info.rst | 23 +++++++++++++----------
docs/uri-scheme-browse-release.rst | 2 ++
docs/uri-scheme-browse-revision.rst | 20 ++++++++++++--------
docs/uri-scheme-browse.rst | 6 +++---
4 files changed, 30 insertions(+), 21 deletions(-)
diff --git a/docs/developers-info.rst b/docs/developers-info.rst
index e89a6b126..dc2c2af3f 100644
--- a/docs/developers-info.rst
+++ b/docs/developers-info.rst
@@ -50,7 +50,7 @@ Configuration and settings
* :mod:`swh.web.doc_config`: utility module used to extend the sphinx configuration
when building the documentation.
* :mod:`swh.web.manage`: Django management module for developpers.
- * :mod:`swh.web.urls`: module that holds the whole URI scheme of all
+ * :mod:`swh.web.urls`: module that holds the whole URI scheme of all
the web applications.
* :mod:`swh.web.wsgi`: WSGI module to use when deploying the web applications
in production.
@@ -62,25 +62,25 @@ Configuration and settings
Common utilities
""""""""""""""""
- * :mod:`swh.web.common.converters`: conversion module used to transform SWH raw data
- to serializable ones. It is used by :mod:`swh.web.common.service`: to convert data
+ * :mod:`swh.web.common.converters`: conversion module used to transform SWH raw data
+ to serializable ones. It is used by :mod:`swh.web.common.service`: to convert data
before transmitting then to Django views.
* :mod:`swh.web.common.exc`: module defining exceptions used in the web applications.
* :mod:`swh.web.common.highlightjs`: utility module to ease the use of the highlightjs_
library in produced Django views.
- * :mod:`swh.web.common.query`: Utilities to parse data from HTTP endpoints. It is used
+ * :mod:`swh.web.common.query`: Utilities to parse data from HTTP endpoints. It is used
by :mod:`swh.web.common.service`.
* :mod:`swh.web.common.service`: Orchestration layer used by views module
- in charge of communication with :mod:`swh.storage` to retrieve information and
+ in charge of communication with :mod:`swh.storage` to retrieve information and
perform conversion for the upper layer.
* :mod:`swh.web.common.swh_templatetags`: Custom Django template tags library for swh.
- * :mod:`swh.web.common.throttling`: Custom request rate limiter to use with the `Django REST Framework
+ * :mod:`swh.web.common.throttling`: Custom request rate limiter to use with the `Django REST Framework
<http://www.django-rest-framework.org/>`_
- * :mod:`swh.web.common.urlsindex`: Utilities to help the registering of endpoints
+ * :mod:`swh.web.common.urlsindex`: Utilities to help the registering of endpoints
for the web applications
* :mod:`swh.web.common.utils`: Utility functions used in the web applications implementation
-
-
+
+
SWH Web API application
^^^^^^^^^^^^^^^^^^^^^^^
@@ -121,8 +121,11 @@ SWH Web browse application
endpoints implementation.
* :mod:`swh.web.browse.views.content`: Implementation of endpoints for browsing SWH contents.
* :mod:`swh.web.browse.views.directory`: Implementation of endpoints for browsing SWH directories.
+ * :mod:`swh.web.browse.views.identifiers`: Implementation of endpoints for browsing SWH objects
+ through persistent identifiers.
* :mod:`swh.web.browse.views.origin`: Implementation of endpoints for browsing SWH origins.
* :mod:`swh.web.browse.views.person`: Implementation of endpoints for browsing SWH persons.
+ * :mod:`swh.web.browse.views.release`: Implementation of endpoints for browsing SWH releases.
* :mod:`swh.web.browse.views.revision`: Implementation of endpoints for browsing SWH revisions.
-
+
.. _highlightjs: https://highlightjs.org/
diff --git a/docs/uri-scheme-browse-release.rst b/docs/uri-scheme-browse-release.rst
index 1938b52a8..608c1b507 100644
--- a/docs/uri-scheme-browse-release.rst
+++ b/docs/uri-scheme-browse-release.rst
@@ -17,6 +17,8 @@ Release
:statuscode 200: no error
:statuscode 404: requested release can not be found in the SWH archive
+ **Examples:**
+
.. parsed-literal::
:swh_web_browse:`release/208f61cc7a5dbc9879ae6e5c2f95891e270f09ef/`
diff --git a/docs/uri-scheme-browse-revision.rst b/docs/uri-scheme-browse-revision.rst
index 9990ccd80..8d6f435ea 100644
--- a/docs/uri-scheme-browse-revision.rst
+++ b/docs/uri-scheme-browse-revision.rst
@@ -4,7 +4,7 @@ Revision
.. http:get:: /browse/revision/(sha1_git)/
HTML view that displays the metadata associated to a SWH revision.
- It notably shows the revision date and message but also offers
+ It notably shows the revision date and message but also offers
links to get more details on:
* the author
@@ -13,10 +13,12 @@ Revision
* the history log reachable from that revision
:param string sha1_git: hexadecimal representation for the *sha1_git*
- identifier of a SWH revision
+ identifier of a SWH revision
:statuscode 200: no error
:statuscode 404: requested revision can not be found in the SWH archive
+ **Examples:**
+
.. parsed-literal::
:swh_web_browse:`revision/f1b94134a4b879bc55c3dacdb496690c8ebdc03f/`
@@ -24,7 +26,7 @@ Revision
.. http:get:: /browse/revision/(sha1_git)/log/
- HTML view that displays the list of revisions heading to
+ HTML view that displays the list of revisions heading to
a given one. In other words, it shows a commit log.
The following data are displayed for each log entry:
@@ -42,18 +44,20 @@ Revision
* *Older*: fetch and display if available the N older log entries
than the ones currently displayed
- :param string sha1_git: hexadecimal representation for the *sha1_git*
- identifier of a SWH revision
- :query string revs_breadcrumb: used internally to store
+ :param string sha1_git: hexadecimal representation for the *sha1_git*
+ identifier of a SWH revision
+ :query string revs_breadcrumb: used internally to store
the navigation breadcrumbs (i.e. the list of descendant revisions
- visited so far). It must be a string in the form
+ visited so far). It must be a string in the form
"<rev_1>[/<rev_2>/.../<rev_n>]" where rev_i corresponds to a
revision sha1_git.
- :query int per_page: the number of log entries to display per page
+ :query int per_page: the number of log entries to display per page
(default is 20, max is 50)
:statuscode 200: no error
:statuscode 404: requested revision can not be found in the SWH archive
+ **Examples:**
+
.. parsed-literal::
:swh_web_browse:`revision/f1b94134a4b879bc55c3dacdb496690c8ebdc03f/log/`
diff --git a/docs/uri-scheme-browse.rst b/docs/uri-scheme-browse.rst
index 7eefa3cba..a950afe9b 100644
--- a/docs/uri-scheme-browse.rst
+++ b/docs/uri-scheme-browse.rst
@@ -85,12 +85,12 @@ SWH Browse Urls
.. include:: uri-scheme-browse-directory.rst
+.. include:: uri-scheme-browse-identifiers.rst
+
.. include:: uri-scheme-browse-origin.rst
.. include:: uri-scheme-browse-person.rst
-.. include:: uri-scheme-browse-revision.rst
-
.. include:: uri-scheme-browse-release.rst
-.. include:: uri-scheme-browse-identifiers.rst
+.. include:: uri-scheme-browse-revision.rst
--
GitLab