trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jpe...@apache.org
Subject git commit: TS-2797: Build all manual pages in the doc/reference/api directory
Date Mon, 12 May 2014 21:26:50 GMT
Repository: trafficserver
Updated Branches:
  refs/heads/master c7df50254 -> 4361cd46a


TS-2797: Build all manual pages in the doc/reference/api directory

Not all of the manpages are getting built because they are not part
of the man_pages list in doc/conf.py

This patch adds all of the files in the doc/reference/api directory
to the list of manual pages. It also adds the manual page descriptions
to the HTML output.

This closes #82


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/4361cd46
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/4361cd46
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/4361cd46

Branch: refs/heads/master
Commit: 4361cd46afcb6ad7b873289f5531879af8bf31c0
Parents: c7df502
Author: Jack Bates <jack@nottheoilrig.com>
Authored: Mon May 12 13:28:40 2014 -0700
Committer: James Peach <jpeach@apache.org>
Committed: Mon May 12 14:26:05 2014 -0700

----------------------------------------------------------------------
 CHANGES                                         |   2 +
 doc/conf.py                                     | 132 ++++++++++++-------
 doc/reference/api/TSAPI.en.rst                  |   2 +
 doc/reference/api/TSDebug.en.rst                |   2 +
 doc/reference/api/TSHttpHookAdd.en.rst          |   2 +
 doc/reference/api/TSHttpParserCreate.en.rst     |   2 +
 doc/reference/api/TSHttpTxnMilestoneGet.en.rst  |   2 +
 .../api/TSHttpTxnServerIntercept.en.rst         |   2 +
 doc/reference/api/TSIOBufferCreate.en.rst       |   2 +
 doc/reference/api/TSInstallDirGet.en.rst        |   2 +
 doc/reference/api/TSMBufferCreate.en.rst        |   2 +
 .../api/TSMimeHdrFieldValueStringGet.en.rst     |   2 +
 doc/reference/api/TSPluginInit.en.rst           |   2 +
 doc/reference/api/TSRemap.en.rst                |   2 +
 doc/reference/api/TSTextLogObjectCreate.en.rst  |   2 +
 .../api/TSTrafficServerVersionGet.en.rst        |   2 +
 doc/reference/api/TSUrlCreate.en.rst            |   2 +
 doc/reference/api/TSUrlHostGet.en.rst           |   2 +
 doc/reference/api/TSUrlHostSet.en.rst           |   2 +
 doc/reference/api/TSUrlPercentEncode.en.rst     |   2 +
 doc/reference/api/TSUrlStringGet.en.rst         |   2 +
 doc/reference/api/TSmalloc.en.rst               |   2 +
 22 files changed, 125 insertions(+), 49 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/CHANGES
----------------------------------------------------------------------
diff --git a/CHANGES b/CHANGES
index 7ed749a..5f2ed27 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,6 +1,8 @@
                                                          -*- coding: utf-8 -*-
 Changes with Apache Traffic Server 5.0.0
 
+  *) [TS-2797] Build all manual pages in the doc/reference/api directory
+
   *) [TS-2716] Fix indentation for ts_lua plugin.
 
   *) [TS-2789] Typo in HttpSessionManger would cause ATS reuse wrong session to origin server.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/conf.py
----------------------------------------------------------------------
diff --git a/doc/conf.py b/doc/conf.py
index 9b4b66e..117af95 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -253,61 +253,95 @@ latex_documents = [
 # (source start file, name, description, authors, manual section).
 man_pages = [
 
-   ('reference/api/TSAPI.en', 'TSAPI', u'Introduction to the Apache Traffic Server API',
None, u'3ts'),
-   ('reference/api/TSDebug.en', 'TSDebug', u'Traffic Server Debugging APIs', None, u'3ts'),
-   ('reference/api/TSHttpHookAdd.en', 'TSHttpHookAdd', u'Intercept Traffic Server events',
None, u'3ts'),
-   ('reference/api/TSHttpParserCreate.en', 'TSHttpParserCreate', u'Parse HTTP headers from
memory buffers', None, u'3ts'),
-   ('reference/api/TSHttpTxnMilestoneGet.en', 'TSHttpTxnMilestoneGet', u'Get a specified
milestone timer value for the current transaction', None, u'3ts'),
-   ('reference/api/TSHttpTxnServerIntercept.en', 'TSHttpTxnServerIntercept', u'Intercept
origin server requests', None, u'3ts'),
-   ('reference/api/TSIOBufferCreate.en', 'TSIOBufferCreate', u'Traffic Server IO buffer API',
None, u'3ts'),
-   ('reference/api/TSInstallDirGet.en', 'TSInstallDirGet', u'Return Traffic Server installation
directories', None, u'3ts'),
-   ('reference/api/TSMBufferCreate.en', 'TSMBufferCreate', u'Traffic Server marshall buffer
API', None, u'3ts'),
-   ('reference/api/TSmalloc.en', 'TSmalloc', u'Traffic Server memory allocation API', None,
u'3ts'),
-   ('reference/api/TSPluginInit.en', 'TSPluginInit', u'Traffic Server plugin loading and
registration', None, u'3ts'),
-   ('reference/api/TSRemap.en', 'TSRemap', u'Traffic Server remap plugin entry points ',
None, u'3ts'),
-   ('reference/api/TSTrafficServerVersionGet.en', 'TSTrafficServerVersionGet', u'return Traffic
Server version information', None, u'3ts'),
-   ('reference/api/TSTextLogObjectCreate.en', 'TextLogObjectCreate', u'Traffic Server text
logging API', None, u'3ts'),
-   ('reference/api/TSUrlCreate.en', 'TSUrlCreate', u'Traffic Server URL object construction
API', None, u'3ts'),
-   ('reference/api/TSUrlHostGet.en', 'TSUrlHostGet', u'Traffic Server URL component retrieval
API', None, u'3ts'),
-   ('reference/api/TSUrlHostSet.en', 'TSUrlHostSet', u'Traffic Server URL component manipulation
API', None, u'3ts'),
-   ('reference/api/TSUrlPercentEncode.en', 'TSUrlPercentEncode', u'Traffic Server URL percent
encoding API', None, u'3ts'),
-   ('reference/api/TSUrlStringGet.en', 'TSUrlStringGet', u'Traffic Server URL string representations
API', None, u'3ts'),
-   ('reference/api/TSMimeHdrFieldValueStringGet.en', 'TSMimeHdrFieldValueStringGet', u'Get
HTTP MIME header values', None, u'3ts'),
-
-   ('reference/commands/traffic_cop.en', 'traffic_cop', u'Traffic Server watchdog', None,
'8'),
-   ('reference/commands/traffic_line.en', 'traffic_line', u'Traffic Server command line',
None, '8'),
-   ('reference/commands/traffic_logcat.en', 'traffic_logcat', u'Traffic Server log spooler',
None, '8'),
-   ('reference/commands/traffic_logstats.en', 'traffic_logstats', u'Traffic Server analyzer',
None, '8'),
-   ('reference/commands/traffic_manager.en', 'traffic_manager', u'Traffic Server process
manager', None, '8'),
-   ('reference/commands/traffic_server.en', 'traffic_server', u'Traffic Server', None, '8'),
-   ('reference/commands/traffic_shell.en', 'traffic_shell', u'Traffic Server shell', None,
'8'),
-
-   ('reference/commands/tspush.en', 'tspush', u'Push objects into the Traffic Server cache',
None, '1'),
-   ('reference/commands/traffic_top.en','traffic_top', u'Display Traffic Server statistics',
None, '1'),
-   ('reference/commands/tsxs.en', 'tsxs', u'Traffic Server plugin tool', None, '1'),
-
-   ('reference/configuration/cache.config.en', 'cache.config', u'Traffic Server cache configuration
file', None, '5'),
-   ('reference/configuration/congestion.config.en', 'congestion.config', u'Traffic Server
congestion control configuration file', None, '5'),
-   ('reference/configuration/hosting.config.en', 'hosting.config', u'Traffic Server domain
hosting configuration file', None, '5'),
-   ('reference/configuration/icp.config.en', 'icp.config', u'Traffic Server ICP configuration
file', None, '5'),
-   ('reference/configuration/ip_allow.config.en', 'ip_allow.config', u'Traffic Server IP
access control configuration file', None, '5'),
-   ('reference/configuration/log_hosts.config.en', 'log_hosts.config', u'Traffic Server log
host configuration file', None, '5'),
-   ('reference/configuration/logs_xml.config.en', 'logs_xml.config', u'Traffic Server log
format configuration file', None, '5'),
-   ('reference/configuration/parent.config.en', 'parent.config', u'Traffic Server parent
cache configuration file', None, '5'),
-   ('reference/configuration/plugin.config.en', 'plugin.config', u'Traffic Server global
plugin configuration file', None, '5'),
-   ('reference/configuration/records.config.en', 'records.config', u'Traffic Server configuration
file', None, '5'),
-   ('reference/configuration/remap.config.en', 'remap.config', u'Traffic Server remap rules
configuration file', None, '5'),
-   ('reference/configuration/splitdns.config.en', 'splitdns.config', u'Traffic Server split
DNS configuration file', None, '5'),
-   ('reference/configuration/ssl_multicert.config.en', 'ssl_multicert.config', u'Traffic
Server SSL certificate configuration file', None, '5'),
-   ('reference/configuration/storage.config.en', 'storage.config', u'Traffic Server cache
storage configuration file', None, '5'),
-   ('reference/configuration/update.config.en', 'update.config', u'Traffic Server automated
update configuration file', None, '5'),
-   ('reference/configuration/volume.config.en', 'volume.config', u'Traffic Server cache volume
configuration file', None, '5'),
+  # Add all files in the reference/api directory to the list of manual
+  # pages
+  ('reference/api/' + filename[:-4], filename.split('.', 1)[0], '', None, '3ts') for filename
in os.listdir('reference/api') if filename != 'index.en.rst' and filename.endswith('.rst')]
+ [
+
+  ('reference/commands/traffic_cop.en', 'traffic_cop', u'Traffic Server watchdog', None,
'8'),
+  ('reference/commands/traffic_line.en', 'traffic_line', u'Traffic Server command line',
None, '8'),
+  ('reference/commands/traffic_logcat.en', 'traffic_logcat', u'Traffic Server log spooler',
None, '8'),
+  ('reference/commands/traffic_logstats.en', 'traffic_logstats', u'Traffic Server analyzer',
None, '8'),
+  ('reference/commands/traffic_manager.en', 'traffic_manager', u'Traffic Server process manager',
None, '8'),
+  ('reference/commands/traffic_server.en', 'traffic_server', u'Traffic Server', None, '8'),
+  ('reference/commands/traffic_shell.en', 'traffic_shell', u'Traffic Server shell', None,
'8'),
+
+  ('reference/commands/tspush.en', 'tspush', u'Push objects into the Traffic Server cache',
None, '1'),
+  ('reference/commands/traffic_top.en','traffic_top', u'Display Traffic Server statistics',
None, '1'),
+  ('reference/commands/tsxs.en', 'tsxs', u'Traffic Server plugin tool', None, '1'),
+
+  ('reference/configuration/cache.config.en', 'cache.config', u'Traffic Server cache configuration
file', None, '5'),
+  ('reference/configuration/congestion.config.en', 'congestion.config', u'Traffic Server
congestion control configuration file', None, '5'),
+  ('reference/configuration/hosting.config.en', 'hosting.config', u'Traffic Server domain
hosting configuration file', None, '5'),
+  ('reference/configuration/icp.config.en', 'icp.config', u'Traffic Server ICP configuration
file', None, '5'),
+  ('reference/configuration/ip_allow.config.en', 'ip_allow.config', u'Traffic Server IP access
control configuration file', None, '5'),
+  ('reference/configuration/log_hosts.config.en', 'log_hosts.config', u'Traffic Server log
host configuration file', None, '5'),
+  ('reference/configuration/logs_xml.config.en', 'logs_xml.config', u'Traffic Server log
format configuration file', None, '5'),
+  ('reference/configuration/parent.config.en', 'parent.config', u'Traffic Server parent cache
configuration file', None, '5'),
+  ('reference/configuration/plugin.config.en', 'plugin.config', u'Traffic Server global plugin
configuration file', None, '5'),
+  ('reference/configuration/records.config.en', 'records.config', u'Traffic Server configuration
file', None, '5'),
+  ('reference/configuration/remap.config.en', 'remap.config', u'Traffic Server remap rules
configuration file', None, '5'),
+  ('reference/configuration/splitdns.config.en', 'splitdns.config', u'Traffic Server split
DNS configuration file', None, '5'),
+  ('reference/configuration/ssl_multicert.config.en', 'ssl_multicert.config', u'Traffic Server
SSL certificate configuration file', None, '5'),
+  ('reference/configuration/storage.config.en', 'storage.config', u'Traffic Server cache
storage configuration file', None, '5'),
+  ('reference/configuration/update.config.en', 'update.config', u'Traffic Server automated
update configuration file', None, '5'),
+  ('reference/configuration/volume.config.en', 'volume.config', u'Traffic Server cache volume
configuration file', None, '5'),
 
 ]
 
 # If true, show URL addresses after external links.
 #man_show_urls = False
 
+# Get the manual page description from the reStructuredText document.
+# This keeps the list of manual pages consistent with the source
+# documents and includes the same brief description in both the HTML
+# and manual page outputs.
+
+from docutils import nodes
+from docutils.transforms import frontmatter
+from sphinx.writers import manpage
+
+# Override ManualPageWriter and ManualPageTranslator in the only way
+# that Sphinx supports
+
+BaseWriter = manpage.ManualPageWriter
+class ManualPageWriter(BaseWriter):
+  def translate(self):
+    transform = frontmatter.DocTitle(self.document)
+
+    section, index = transform.candidate_index(self.document)
+    if index:
+
+      # A sentence after the title is the manual page description
+      if len(section) > 1 and isinstance(section[1], nodes.paragraph):
+
+        description = section.pop(1).astext()
+        description = description[:1].lower() + description[1:]
+        description = description.rstrip('.')
+
+        self.document.settings.subtitle = description
+
+      # Instead of section_level = -1, use the standard Docutils
+      # DocTitle transform to hide the top level title
+      transform.promote_title(self.document)
+
+    # The title is the manual page name
+    transform.set_metadata()
+
+    BaseWriter.translate(self)
+
+manpage.ManualPageWriter = ManualPageWriter
+
+BaseTranslator = manpage.ManualPageTranslator
+class ManualPageTranslator(BaseTranslator):
+  def __init__(self, builder, *args, **kwds):
+    BaseTranslator.__init__(self, builder, *args, **kwds)
+
+    # Instead of section_level = -1, use the standard Docutils
+    # DocTitle transform to hide the top level title
+    self.section_level = 0
+
+manpage.ManualPageTranslator = ManualPageTranslator
+
 # -- Options for Texinfo output ------------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSAPI.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSAPI.en.rst b/doc/reference/api/TSAPI.en.rst
index df24011..bfc9c5a 100644
--- a/doc/reference/api/TSAPI.en.rst
+++ b/doc/reference/api/TSAPI.en.rst
@@ -20,6 +20,8 @@
 TSAPI
 =====
 
+Introduction to the Apache Traffic Server API.
+
 Synopsis
 ========
 | `#include <ts/ts.h>`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSDebug.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSDebug.en.rst b/doc/reference/api/TSDebug.en.rst
index 7fc21db..e3b8d9d 100644
--- a/doc/reference/api/TSDebug.en.rst
+++ b/doc/reference/api/TSDebug.en.rst
@@ -20,6 +20,8 @@
 TSDebug
 =======
 
+Traffic Server Debugging APIs.
+
 Synopsis
 ========
 `#include <ts/ts.h>`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSHttpHookAdd.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpHookAdd.en.rst b/doc/reference/api/TSHttpHookAdd.en.rst
index eebcb21..8fc009b 100644
--- a/doc/reference/api/TSHttpHookAdd.en.rst
+++ b/doc/reference/api/TSHttpHookAdd.en.rst
@@ -21,6 +21,8 @@
 TSHttpHookAdd
 =============
 
+Intercept Traffic Server events.
+
 Synopsis
 ========
 `#include <ts/ts.h>`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSHttpParserCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpParserCreate.en.rst b/doc/reference/api/TSHttpParserCreate.en.rst
index 64f6ea8..7b85748 100644
--- a/doc/reference/api/TSHttpParserCreate.en.rst
+++ b/doc/reference/api/TSHttpParserCreate.en.rst
@@ -21,6 +21,8 @@
 TSHttpParserCreate
 ===================
 
+Parse HTTP headers from memory buffers.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSHttpTxnMilestoneGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnMilestoneGet.en.rst b/doc/reference/api/TSHttpTxnMilestoneGet.en.rst
index da1188b..0e9f1ff 100644
--- a/doc/reference/api/TSHttpTxnMilestoneGet.en.rst
+++ b/doc/reference/api/TSHttpTxnMilestoneGet.en.rst
@@ -21,6 +21,8 @@
 TSHttpTxnMilestoneGet
 =====================
 
+Get a specified milestone timer value for the current transaction.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSHttpTxnServerIntercept.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnServerIntercept.en.rst b/doc/reference/api/TSHttpTxnServerIntercept.en.rst
index 850638e..7f066c3 100644
--- a/doc/reference/api/TSHttpTxnServerIntercept.en.rst
+++ b/doc/reference/api/TSHttpTxnServerIntercept.en.rst
@@ -21,6 +21,8 @@
 TSHttpTxnServerIntercept
 ========================
 
+Intercept origin server requests.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSIOBufferCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSIOBufferCreate.en.rst b/doc/reference/api/TSIOBufferCreate.en.rst
index f43cc4e..b902cfe 100644
--- a/doc/reference/api/TSIOBufferCreate.en.rst
+++ b/doc/reference/api/TSIOBufferCreate.en.rst
@@ -21,6 +21,8 @@
 TSIOBufferCreate
 ================
 
+Traffic Server IO buffer API.
+
 Synopsis
 ========
 `#include <ts/ts.h>`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSInstallDirGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSInstallDirGet.en.rst b/doc/reference/api/TSInstallDirGet.en.rst
index 4b55520..9d310de 100644
--- a/doc/reference/api/TSInstallDirGet.en.rst
+++ b/doc/reference/api/TSInstallDirGet.en.rst
@@ -21,6 +21,8 @@
 TSInstallDirGet
 ===============
 
+Return Traffic Server installation directories.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSMBufferCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMBufferCreate.en.rst b/doc/reference/api/TSMBufferCreate.en.rst
index 600e570..5277a05 100644
--- a/doc/reference/api/TSMBufferCreate.en.rst
+++ b/doc/reference/api/TSMBufferCreate.en.rst
@@ -20,6 +20,8 @@
 TSMBufferCreate
 ===============
 
+Traffic Server marshall buffer API.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSMimeHdrFieldValueStringGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValueStringGet.en.rst b/doc/reference/api/TSMimeHdrFieldValueStringGet.en.rst
index 75453c7..2e4048d 100644
--- a/doc/reference/api/TSMimeHdrFieldValueStringGet.en.rst
+++ b/doc/reference/api/TSMimeHdrFieldValueStringGet.en.rst
@@ -20,6 +20,8 @@
 TSMimeHdrFieldValueStringGet
 ============================
 
+Get HTTP MIME header values.
+
 
 Synopsis
 ========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSPluginInit.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSPluginInit.en.rst b/doc/reference/api/TSPluginInit.en.rst
index db84bda..d4637c1 100644
--- a/doc/reference/api/TSPluginInit.en.rst
+++ b/doc/reference/api/TSPluginInit.en.rst
@@ -20,6 +20,8 @@
 TSPluginInit
 ============
 
+Traffic Server plugin loading and registration.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSRemap.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSRemap.en.rst b/doc/reference/api/TSRemap.en.rst
index e0cb597..7542cac 100644
--- a/doc/reference/api/TSRemap.en.rst
+++ b/doc/reference/api/TSRemap.en.rst
@@ -20,6 +20,8 @@
 TSRemapInit
 ===========
 
+Traffic Server remap plugin entry points.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSTextLogObjectCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSTextLogObjectCreate.en.rst b/doc/reference/api/TSTextLogObjectCreate.en.rst
index 00eaa82..8a4684b 100644
--- a/doc/reference/api/TSTextLogObjectCreate.en.rst
+++ b/doc/reference/api/TSTextLogObjectCreate.en.rst
@@ -21,6 +21,8 @@
 TSTextLogObjectCreate
 =====================
 
+Traffic Server text logging API.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSTrafficServerVersionGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSTrafficServerVersionGet.en.rst b/doc/reference/api/TSTrafficServerVersionGet.en.rst
index e450743..9f7681f 100644
--- a/doc/reference/api/TSTrafficServerVersionGet.en.rst
+++ b/doc/reference/api/TSTrafficServerVersionGet.en.rst
@@ -20,6 +20,8 @@
 TSTrafficServerVersionGet
 =========================
 
+Return Traffic Server version information.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSUrlCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlCreate.en.rst b/doc/reference/api/TSUrlCreate.en.rst
index 8e0275f..ad15af0 100644
--- a/doc/reference/api/TSUrlCreate.en.rst
+++ b/doc/reference/api/TSUrlCreate.en.rst
@@ -21,6 +21,8 @@
 TSUrlCreate
 ===========
 
+Traffic Server URL object construction API.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSUrlHostGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlHostGet.en.rst b/doc/reference/api/TSUrlHostGet.en.rst
index f974419..fbaa7bf 100644
--- a/doc/reference/api/TSUrlHostGet.en.rst
+++ b/doc/reference/api/TSUrlHostGet.en.rst
@@ -21,6 +21,8 @@
 TSUrlHostGet
 ============
 
+Traffic Server URL component retrieval API.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSUrlHostSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlHostSet.en.rst b/doc/reference/api/TSUrlHostSet.en.rst
index 5736cb3..8935ed9 100644
--- a/doc/reference/api/TSUrlHostSet.en.rst
+++ b/doc/reference/api/TSUrlHostSet.en.rst
@@ -21,6 +21,8 @@
 TSUrlHostSet
 ============
 
+Traffic Server URL component manipulation API.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSUrlPercentEncode.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlPercentEncode.en.rst b/doc/reference/api/TSUrlPercentEncode.en.rst
index e83aab4..5a75930 100644
--- a/doc/reference/api/TSUrlPercentEncode.en.rst
+++ b/doc/reference/api/TSUrlPercentEncode.en.rst
@@ -21,6 +21,8 @@
 TSUrlPercentEncode
 ==================
 
+Traffic Server URL percent encoding API.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSUrlStringGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlStringGet.en.rst b/doc/reference/api/TSUrlStringGet.en.rst
index 30a08bb..8c15bac 100644
--- a/doc/reference/api/TSUrlStringGet.en.rst
+++ b/doc/reference/api/TSUrlStringGet.en.rst
@@ -21,6 +21,8 @@
 TSUrlStringGet
 ==============
 
+Traffic Server URL string representations API.
+
 Synopsis
 ========
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/4361cd46/doc/reference/api/TSmalloc.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSmalloc.en.rst b/doc/reference/api/TSmalloc.en.rst
index ea4f81a..19da27f 100644
--- a/doc/reference/api/TSmalloc.en.rst
+++ b/doc/reference/api/TSmalloc.en.rst
@@ -21,6 +21,8 @@
 TSmalloc
 ========
 
+Traffic Server memory allocation API.
+
 Synopsis
 ========
 


Mime
View raw message