Consistently use sentence case for headings (#12987)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
Tim Hoffmann 2024-10-09 00:04:18 +02:00 committed by GitHub
parent 886bb945af
commit 6cf3f9238e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 18 additions and 18 deletions

View File

@ -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

View File

@ -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

View File

@ -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::

View File

@ -2,7 +2,7 @@
.. currentmodule:: sphinxcontrib.websupport
The WebSupport Class
The WebSupport class
====================
.. class:: WebSupport

View File

@ -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/<path:docname>')
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

View File

@ -2,7 +2,7 @@
.. currentmodule:: sphinxcontrib.websupport.search
Search Adapters
Search adapters
===============
To create a custom search adapter you will need to subclass the

View File

@ -2,7 +2,7 @@
.. currentmodule:: sphinxcontrib.websupport.storage
Storage Backends
Storage backends
================
To create a custom storage backend you will need to subclass the

View File

@ -1,5 +1,5 @@
===============
Getting Started
Getting started
===============
Sphinx is a *documentation generator* or a tool that translates a set of plain

View File

@ -2,7 +2,7 @@
.. _html-themes:
HTML Theming
HTML theming
============
Sphinx provides a number of builders for HTML and HTML-based formats.