From 6cf3f9238efaa40d963adcd06ddaa29de368c156 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Wed, 9 Oct 2024 00:04:18 +0200 Subject: [PATCH] Consistently use sentence case for headings (#12987) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- doc/extdev/index.rst | 2 +- doc/index.rst | 6 +++--- doc/man/index.rst | 6 +++--- doc/usage/advanced/websupport/api.rst | 2 +- doc/usage/advanced/websupport/quickstart.rst | 12 ++++++------ doc/usage/advanced/websupport/searchadapters.rst | 2 +- doc/usage/advanced/websupport/storagebackends.rst | 2 +- doc/usage/quickstart.rst | 2 +- doc/usage/theming.rst | 2 +- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 700eda592..5160cd45e 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -89,7 +89,7 @@ To see an example of use of these objects, refer to .. _build-phases: -Build Phases +Build phases ------------ One thing that is vital in order to understand extension mechanisms is the way diff --git a/doc/index.rst b/doc/index.rst index f1cde1fd5..0946fbe98 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -137,8 +137,8 @@ creating and building your own documentation from scratch. .. _user-guides: -User Guides -=========== +User guide +========== These sections cover various topics in using and extending Sphinx for various use-cases. They are a comprehensive guide to using Sphinx in many contexts and @@ -147,7 +147,7 @@ starting with :ref:`get-started`. .. toctree:: :maxdepth: 2 - :caption: User Guides + :caption: User guide usage/index development/index diff --git a/doc/man/index.rst b/doc/man/index.rst index 14680228b..65922b238 100644 --- a/doc/man/index.rst +++ b/doc/man/index.rst @@ -1,9 +1,9 @@ -Command-Line Tools +Command-line tools ================== These are the applications provided as part of Sphinx. -Core Applications +Core applications ----------------- .. toctree:: @@ -12,7 +12,7 @@ Core Applications sphinx-quickstart sphinx-build -Additional Applications +Additional applications ----------------------- .. toctree:: diff --git a/doc/usage/advanced/websupport/api.rst b/doc/usage/advanced/websupport/api.rst index 79b51ee6d..c657433f0 100644 --- a/doc/usage/advanced/websupport/api.rst +++ b/doc/usage/advanced/websupport/api.rst @@ -2,7 +2,7 @@ .. currentmodule:: sphinxcontrib.websupport -The WebSupport Class +The WebSupport class ==================== .. class:: WebSupport diff --git a/doc/usage/advanced/websupport/quickstart.rst b/doc/usage/advanced/websupport/quickstart.rst index b75c61784..097d79eda 100644 --- a/doc/usage/advanced/websupport/quickstart.rst +++ b/doc/usage/advanced/websupport/quickstart.rst @@ -3,8 +3,8 @@ Web Support Quick Start ======================= -Building Documentation Data ----------------------------- +Building documentation data +--------------------------- To make use of the web support package in your application you'll need to build the data it uses. This data includes pickle files representing documents, @@ -33,7 +33,7 @@ called "static" and contains static files that should be served from "/static". :class:`~.WebSupport` object. -Integrating Sphinx Documents Into Your Webapp +Integrating Sphinx documents into your web-app ---------------------------------------------- Now that the data is built, it's time to do something useful with it. Start off @@ -145,7 +145,7 @@ add this data to the ``COMMENT_OPTIONS`` that are used in the template. @app.route('/docs/') -Performing Searches +Performing searches ------------------- To use the search form built-in to the Sphinx sidebar, create a function to @@ -167,7 +167,7 @@ returns a context dict in the same format that :meth:`~.WebSupport.get_document` does. -Comments & Proposals +Comments & proposals -------------------- Now that this is done it's time to define the functions that handle the AJAX @@ -217,7 +217,7 @@ and will handle user votes on comments:: return "success" -Comment Moderation +Comment moderation ------------------ By default, all comments added through :meth:`~.WebSupport.add_comment` are diff --git a/doc/usage/advanced/websupport/searchadapters.rst b/doc/usage/advanced/websupport/searchadapters.rst index ad7a11c7f..d8e1adcb5 100644 --- a/doc/usage/advanced/websupport/searchadapters.rst +++ b/doc/usage/advanced/websupport/searchadapters.rst @@ -2,7 +2,7 @@ .. currentmodule:: sphinxcontrib.websupport.search -Search Adapters +Search adapters =============== To create a custom search adapter you will need to subclass the diff --git a/doc/usage/advanced/websupport/storagebackends.rst b/doc/usage/advanced/websupport/storagebackends.rst index c50edf811..9ba148066 100644 --- a/doc/usage/advanced/websupport/storagebackends.rst +++ b/doc/usage/advanced/websupport/storagebackends.rst @@ -2,7 +2,7 @@ .. currentmodule:: sphinxcontrib.websupport.storage -Storage Backends +Storage backends ================ To create a custom storage backend you will need to subclass the diff --git a/doc/usage/quickstart.rst b/doc/usage/quickstart.rst index 774a581a0..4c3cde892 100644 --- a/doc/usage/quickstart.rst +++ b/doc/usage/quickstart.rst @@ -1,5 +1,5 @@ =============== -Getting Started +Getting started =============== Sphinx is a *documentation generator* or a tool that translates a set of plain diff --git a/doc/usage/theming.rst b/doc/usage/theming.rst index 135c2f55a..a596acfe0 100644 --- a/doc/usage/theming.rst +++ b/doc/usage/theming.rst @@ -2,7 +2,7 @@ .. _html-themes: -HTML Theming +HTML theming ============ Sphinx provides a number of builders for HTML and HTML-based formats.