Fix and standardise markup

Author: AA-Turner

doc/usage/domains/c.rst

@@ -59,6 +59,8 @@ The C domain (name **c**) is suited for documentation of C API.
       ..
          ** for some editors (e.g., vim) to stop bold-highlighting the source
 
+      :no-contents-entry:
+      :no-index-entry:
       :param type: description of the first parameter.
       :param nitems: description of the second parameter.
       :returns: a result.
@@ -224,7 +226,12 @@ The following directive can be used for this purpose.
    becomes
 
    .. c:var:: int data
+      :no-contents-entry:
+      :no-index-entry:
+
    .. c:function:: int f(double k)
+      :no-contents-entry:
+      :no-index-entry:
 
    .. c:alias:: data
                 f

doc/usage/domains/cpp.rst

@@ -230,6 +230,8 @@ visibility statement (``public``, ``private`` or ``protected``).
    This will render as follows:
 
    .. cpp:concept:: template<typename It> std::Iterator
+      :no-contents-entry:
+      :no-index-entry:
 
       Proxy to an element of a notional sequence that can be compared,
       indirected, or incremented.
@@ -623,11 +625,21 @@ As example, consider the following class declaration:
 
 .. cpp:namespace-push:: overload_example
 .. cpp:class:: C
+   :no-contents-entry:
+   :no-index-entry:
 
    .. cpp:function:: void f(double d) const
+      :no-contents-entry:
+      :no-index-entry:
    .. cpp:function:: void f(double d)
+      :no-contents-entry:
+      :no-index-entry:
    .. cpp:function:: void f(int i)
+      :no-contents-entry:
+      :no-index-entry:
    .. cpp:function:: void f()
+      :no-contents-entry:
+      :no-index-entry:
 
 References using the :rst:role:`cpp:func` role:
 
@@ -651,12 +663,18 @@ Templated declarations
 Assume the following declarations.
 
 .. cpp:class:: Wrapper
+   :no-contents-entry:
+   :no-index-entry:
 
    .. cpp:class:: template<typename TOuter> \
                   Outer
+      :no-contents-entry:
+      :no-index-entry:
 
       .. cpp:class:: template<typename TInner> \
                      Inner
+         :no-contents-entry:
+         :no-index-entry:
 
 In general the reference must include the template parameter declarations,
 and template arguments for the prefix of qualified names. For example:
@@ -689,18 +707,28 @@ Assume the following declarations.
 
 .. cpp:class:: template<typename TOuter> \
                Outer
+   :no-contents-entry:
+   :no-index-entry:
 
-  .. cpp:class:: template<typename TInner> \
-                 Inner
+   .. cpp:class:: template<typename TInner> \
+                  Inner
+      :no-contents-entry:
+      :no-index-entry:
 
 .. cpp:class:: template<> \
                Outer<int>
+   :no-contents-entry:
+   :no-index-entry:
 
-  .. cpp:class:: template<typename TInner> \
-                 Inner
+   .. cpp:class:: template<typename TInner> \
+                  Inner
+      :no-contents-entry:
+      :no-index-entry:
 
-  .. cpp:class:: template<> \
-                 Inner<bool>
+   .. cpp:class:: template<> \
+                  Inner<bool>
+      :no-contents-entry:
+      :no-index-entry:
 
 In general the reference must include a template parameter list for each
 template argument list.  The full specialisation above can therefore be
@@ -718,6 +746,8 @@ Assume the following declaration.
 
 .. cpp:class:: template<typename T> \
                Outer<T*>
+   :no-contents-entry:
+   :no-index-entry:
 
 References to partial specialisations must always include the template
 parameter lists, e.g., ``template\<typename T> Outer\<T*>``

doc/usage/domains/javascript.rst

@@ -48,7 +48,8 @@ The JavaScript domain (name **js**) provides the following directives:
    This is rendered as:
 
    .. js:function:: $.getJSON(href, callback[, errback])
-      :no-index:
+      :no-contents-entry:
+      :no-index-entry:
 
       :param string href: An URI to the location of the resource.
       :param callback: Gets called with the object.
@@ -96,7 +97,8 @@ The JavaScript domain (name **js**) provides the following directives:
    This is rendered as:
 
    .. js:class:: MyAnimal(name[, age])
-      :no-index:
+      :no-contents-entry:
+      :no-index-entry:
 
       :param string name: The name of the animal
       :param number age: an optional age for the animal
@@ -123,8 +125,8 @@ The JavaScript domain (name **js**) provides the following directives:
 These roles are provided to refer to the described objects:
 
 .. rst:role:: js:mod
-          js:func
-          js:meth
-          js:class
-          js:data
-          js:attr
+              js:func
+              js:meth
+              js:class
+              js:data
+              js:attr

doc/usage/domains/python.rst

@@ -46,7 +46,6 @@ declarations:
       locations then.
 
 
-
 .. rst:directive:: .. py:currentmodule:: name
 
    This directive tells Sphinx that the classes, functions etc. documented from
@@ -305,7 +304,7 @@ The following directives are provided for module and class contents:
 
       Indicate the property is a classmethod.
 
-      .. versionaddedd: 4.2
+      .. versionadded:: 4.2
 
    .. rst:directive:option:: type: type of the property
       :type: text
@@ -487,7 +486,8 @@ For functions with optional parameters that don't have default values
 argument support), you can use brackets to specify the optional parts:
 
 .. py:function:: compile(source[, filename[, symbol]])
-   :no-index:
+   :no-contents-entry:
+   :no-index-entry:
 
 It is customary to put the opening bracket before the comma.
 
@@ -565,7 +565,8 @@ explained by an example::
 This will render like this:
 
 .. py:function:: send_message(sender, recipient, message_body, [priority=1])
-   :no-index:
+   :no-contents-entry:
+   :no-index-entry:
 
    Send a message to a recipient
 

doc/usage/domains/restructuredtext.rst

@@ -25,12 +25,14 @@ The reStructuredText domain (name **rst**) provides the following directives:
    will be rendered as:
 
    .. rst:directive:: foo
-      :no-index:
+      :no-contents-entry:
+      :no-index-entry:
 
       Foo description.
 
    .. rst:directive:: .. bar:: baz
-      :no-index:
+      :no-contents-entry:
+      :no-index-entry:
 
       Bar description.
 
@@ -84,7 +86,8 @@ The reStructuredText domain (name **rst**) provides the following directives:
    will be rendered as:
 
    .. rst:role:: foo
-      :no-index:
+      :no-contents-entry:
+      :no-index-entry:
 
       Foo description.
 

doc/usage/domains/standard.rst

@@ -84,7 +84,7 @@ There is also a very generic object description directive, which is not tied to
 any domain:
 
 .. rst:directive:: .. describe:: text
-               .. object:: text
+                   .. object:: text
 
    This directive produces the same formatting as the specific ones provided by
    domains, but does not create index entries or cross-referencing targets.