Skip to content

Commit e15fc04

Browse files
committed
Promote underline levels
1 parent 385a919 commit e15fc04

File tree

7 files changed

+40
-33
lines changed

7 files changed

+40
-33
lines changed

doc/usage/domains/c.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. highlight:: rst
22

3+
============
34
The C Domain
4-
------------
5+
============
56

67
The C domain (name **c**) is suited for documentation of C API.
78

@@ -126,7 +127,7 @@ The C domain (name **c**) is suited for documentation of C API.
126127
.. _c-roles:
127128
128129
Cross-referencing C constructs
129-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130+
------------------------------
130131
131132
The following roles create cross-references to C-language constructs if they
132133
are defined in the documentation:
@@ -151,7 +152,7 @@ are defined in the documentation:
151152
152153
153154
Anonymous Entities
154-
~~~~~~~~~~~~~~~~~~
155+
------------------
155156
156157
C supports anonymous structs, enums, and unions.
157158
For the sake of documentation they must be given some name that starts with
@@ -197,7 +198,7 @@ Explicit ref: :c:var:`[email protected]`. Short-hand ref: :c:var:`Data.a`.
197198
198199
199200
Aliasing Declarations
200-
~~~~~~~~~~~~~~~~~~~~~
201+
---------------------
201202
202203
.. c:namespace-push:: @alias
203204
@@ -251,7 +252,7 @@ The following directive can be used for this purpose.
251252
252253
253254
Inline Expressions and Types
254-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
255+
----------------------------
255256
256257
.. rst:role:: c:expr
257258
c:texpr
@@ -287,7 +288,7 @@ Inline Expressions and Types
287288
288289
289290
Namespacing
290-
~~~~~~~~~~~
291+
-----------
291292
292293
.. versionadded:: 3.1
293294
@@ -352,6 +353,6 @@ The ``c:namespace-pop`` directive undoes the most recent
352353
.. c:namespace-push:: A.B
353354
354355
Configuration Variables
355-
~~~~~~~~~~~~~~~~~~~~~~~
356+
-----------------------
356357
357358
See :ref:`c-config`.

doc/usage/domains/cpp.rst

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
.. highlight:: rst
22

3+
==============
34
The C++ Domain
4-
--------------
5+
==============
56

67
The C++ domain (name **cpp**) supports documenting C++ projects.
78

89
Directives for Declaring Entities
9-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10+
---------------------------------
1011

1112
The following directives are available. All declarations can start with a
1213
visibility statement (``public``, ``private`` or ``protected``).
@@ -247,7 +248,7 @@ visibility statement (``public``, ``private`` or ``protected``).
247248

248249

249250
Options
250-
^^^^^^^
251+
~~~~~~~
251252

252253
Some directives support options:
253254

@@ -258,7 +259,7 @@ Some directives support options:
258259
.. versionadded:: 1.6
259260

260261
Anonymous Entities
261-
~~~~~~~~~~~~~~~~~~
262+
------------------
262263

263264
C++ supports anonymous namespaces, classes, enums, and unions.
264265
For the sake of documentation they must be given some name that starts with
@@ -304,7 +305,7 @@ Explicit ref: :cpp:var:`Data::@data::a`. Short-hand ref: :cpp:var:`Data::a`.
304305

305306

306307
Aliasing Declarations
307-
~~~~~~~~~~~~~~~~~~~~~
308+
---------------------
308309

309310
Sometimes it may be helpful list declarations elsewhere than their main
310311
documentation, e.g., when creating a synopsis of a class interface.
@@ -359,7 +360,7 @@ The following directive can be used for this purpose.
359360
360361
361362
Constrained Templates
362-
~~~~~~~~~~~~~~~~~~~~~
363+
---------------------
363364

364365
.. warning:: The support for concepts is experimental. It is based on the
365366
current draft standard and the Concepts Technical Specification.
@@ -368,7 +369,7 @@ Constrained Templates
368369
.. note:: Sphinx does not currently support ``requires`` clauses.
369370

370371
Placeholders
371-
^^^^^^^^^^^^
372+
~~~~~~~~~~~~
372373

373374
Declarations may use the name of a concept to introduce constrained template
374375
parameters, or the keyword ``auto`` to introduce unconstrained template
@@ -384,7 +385,7 @@ parameters::
384385
Iterator concept.
385386

386387
Template Introductions
387-
^^^^^^^^^^^^^^^^^^^^^^
388+
~~~~~~~~~~~~~~~~~~~~~~
388389

389390
Simple constrained function or class templates can be declared with a `template
390391
introduction` instead of a template parameter list::
@@ -419,7 +420,7 @@ compatibility. E.g., ``Iterator{A, B, C}`` will be accepted as an introduction
419420
even though it would not be valid C++.
420421

421422
Inline Expressions and Types
422-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
423+
----------------------------
423424

424425
.. rst:role:: cpp:expr
425426
cpp:texpr
@@ -458,7 +459,7 @@ Inline Expressions and Types
458459
The :rst:role:`cpp:texpr` role.
459460

460461
Namespacing
461-
~~~~~~~~~~~
462+
-----------
462463

463464
Declarations in the C++ domain are as default placed in global scope. The
464465
current scope can be changed using three namespace directives. They manage a
@@ -544,7 +545,7 @@ The ``cpp:namespace-pop`` directive undoes the most recent
544545
.. versionadded:: 1.4
545546

546547
Info field lists
547-
~~~~~~~~~~~~~~~~~
548+
----------------
548549

549550
All the C++ directives for declaring entities support the following
550551
info fields (see also :ref:`info-field-lists`):
@@ -566,7 +567,7 @@ following fields:
566567
.. _cpp-roles:
567568

568569
Cross-referencing
569-
~~~~~~~~~~~~~~~~~
570+
-----------------
570571

571572
These roles link to the given declaration types:
572573

@@ -602,14 +603,14 @@ These roles link to the given declaration types:
602603
angle brackets do not need escaping.
603604

604605
Declarations without template parameters and template arguments
605-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
606+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
606607

607608
For linking to non-templated declarations the name must be a nested name, e.g.,
608609
``f`` or ``MyClass::f``.
609610

610611

611612
Overloaded (member) functions
612-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
613+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
613614

614615
When a (member) function is referenced using just its name, the reference
615616
will point to an arbitrary matching overload.
@@ -643,7 +644,7 @@ does not influence specific overload references.
643644

644645

645646
Templated declarations
646-
^^^^^^^^^^^^^^^^^^^^^^
647+
~~~~~~~~~~~~~~~~~~~~~~
647648

648649
Assume the following declarations.
649650

@@ -680,7 +681,7 @@ This means the following references work as well:
680681
(:cpp:class:`template\<typename TInner> Wrapper::Outer::Inner`)
681682

682683
(Full) Template Specialisations
683-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
684+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
684685

685686
Assume the following declarations.
686687

@@ -709,7 +710,7 @@ shorthand the empty template parameter list can be omitted, e.g.,
709710
(:cpp:class:`Outer\<int>::Inner\<bool>`).
710711

711712
Partial Template Specialisations
712-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
713+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
713714

714715
Assume the following declaration.
715716

@@ -722,6 +723,6 @@ parameter lists, e.g., ``template\<typename T> Outer\<T*>``
722723
succeed if the template parameter identifiers are equal strings.
723724

724725
Configuration Variables
725-
~~~~~~~~~~~~~~~~~~~~~~~
726+
-----------------------
726727

727728
See :ref:`cpp-config`.

doc/usage/domains/javascript.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. highlight:: rst
22

3+
=====================
34
The JavaScript Domain
4-
---------------------
5+
=====================
56

67
The JavaScript domain (name **js**) provides the following directives:
78

doc/usage/domains/mathematics.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. highlight:: rst
22

3+
======================
34
The Mathematics Domain
4-
----------------------
5+
======================
56

67
The math domain (name **math**) provides the following roles:
78

doc/usage/domains/python.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. highlight:: rst
22

3+
=================
34
The Python Domain
4-
-----------------
5+
=================
56

67
The Python domain (name **py**) provides the following directives for module
78
declarations:
@@ -468,7 +469,7 @@ The following directives are provided for module and class contents:
468469
.. _signatures:
469470

470471
Python Signatures
471-
~~~~~~~~~~~~~~~~~
472+
-----------------
472473

473474
Signatures of functions, methods and class constructors can be given like they
474475
would be written in Python.
@@ -512,7 +513,7 @@ See :pep:`695` and :pep:`696` for details and the full specification.
512513
.. _info-field-lists:
513514

514515
Info field lists
515-
~~~~~~~~~~~~~~~~
516+
----------------
516517

517518
.. versionadded:: 0.4
518519
.. versionchanged:: 3.0
@@ -603,7 +604,7 @@ word "or"::
603604
.. _python-roles:
604605

605606
Cross-referencing Python objects
606-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
607+
--------------------------------
607608

608609
The following roles refer to objects in modules and are possibly hyperlinked if
609610
a matching identifier is found:

doc/usage/domains/restructuredtext.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. highlight:: rst
22

3+
===========================
34
The reStructuredText Domain
4-
---------------------------
5+
===========================
56

67
The reStructuredText domain (name **rst**) provides the following directives:
78

doc/usage/domains/standard.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. highlight:: rst
22

3+
===================
34
The Standard Domain
4-
-------------------
5+
===================
56

67
The so-called "standard" domain collects all markup that doesn't warrant a
78
domain of its own. Its directives and roles are not prefixed with a domain

0 commit comments

Comments
 (0)