chiark / gitweb /
documentation/python: test link formatting also for type links.
authorVladimír Vondruš <mosra@centrum.cz>
Fri, 12 Jul 2019 12:01:19 +0000 (14:01 +0200)
committerVladimír Vondruš <mosra@centrum.cz>
Sun, 14 Jul 2019 17:11:08 +0000 (19:11 +0200)
documentation/test_python/link_formatting/c.link_formatting.Class.html
documentation/test_python/link_formatting/link_formatting/__init__.py
documentation/test_python/link_formatting/m.link_formatting.html

index 4989c9b0d7b1f846c00b1f801d0eb76124d34fa1..2fb121272f4dd12111994eec04e9948c41314abb 100644 (file)
@@ -64,7 +64,7 @@
           <h2><a href="#properties">Properties</a></h2>
           <dl class="m-doc">
             <dt>
-              <a href="#p-property" class="m-doc-self" id="p-property">property</a> <span class="m-label m-flat m-warning">get</span>
+              <a href="#p-property" class="m-doc-self" id="p-property">property</a>: <a href="m.link_formatting.html#this-is-an-url#e-Enum" class="m-doc">Enum</a> <span class="m-label m-flat m-warning">get</span>
             </dt>
             <dd>A property.</dd>
           </dl>
index 7e1c65d21a8b615e55b7df5443a88d6adb6b1325..df961e2e2c36cdea9b69ede81d108ce7b6aff07b 100644 (file)
@@ -4,6 +4,14 @@ import enum
 
 from . import sub, pybind
 
+class Enum(enum.Enum):
+    """An enum"""
+
+    FIRST_VALUE = 1
+    SECOND_VALUE = 2
+
+SOME_DATA: Enum = Enum.FIRST_VALUE
+
 class Class:
     """This is a nice class."""
 
@@ -11,14 +19,8 @@ class Class:
         """And a nice subclass, oh."""
 
     @property
-    def property(self):
+    def property(self) -> Enum:
         """A property."""
 
-def function():
+def function(a: Class) -> Enum:
     """A function."""
-
-SOME_DATA = 3.14
-
-class Enum(enum.Enum):
-    FIRST_VALUE = 1
-    SECOND_VALUE = 2
index 13a7059a9a91604b22d7bb8addfd11994a3b720c..76dc48b73f8cc0ce46cb77ed65f2083dbbc2a334 100644 (file)
               <span class="m-doc-wrap-bumper">class <a href="#e-Enum" class="m-doc-self" id="e-Enum">Enum</a>(enum.Enum): </span><span class="m-doc-wrap"><a href="#v-Enum-FIRST_VALUE" class="m-doc-self" id="v-Enum-FIRST_VALUE">FIRST_VALUE</a> = 1
               <a href="#v-Enum-SECOND_VALUE" class="m-doc-self" id="v-Enum-SECOND_VALUE">SECOND_VALUE</a> = 2</span>
             </dt>
-            <dd></dd>
+            <dd>An enum</dd>
           </dl>
         </section>
         <section id="functions">
           <h2><a href="#functions">Functions</a></h2>
           <dl class="m-doc">
             <dt>
-              <span class="m-doc-wrap-bumper">def <a href="#f-function" class="m-doc-self" id="f-function">function</a>(</span><span class="m-doc-wrap">)</span>
+              <span class="m-doc-wrap-bumper">def <a href="#f-function" class="m-doc-self" id="f-function">function</a>(</span><span class="m-doc-wrap">a: <a href="c.link_formatting.Class.html#this-is-an-url" class="m-doc">Class</a>) -&gt; <a href="m.link_formatting.html#this-is-an-url#e-Enum" class="m-doc">Enum</a></span>
             </dt>
             <dd>A function.</dd>
           </dl>
@@ -95,7 +95,7 @@
           <h2><a href="#data">Data</a></h2>
           <dl class="m-doc">
             <dt>
-              <a href="#d-SOME_DATA" class="m-doc-self" id="d-SOME_DATA">SOME_DATA</a> = 3.14
+              <a href="#d-SOME_DATA" class="m-doc-self" id="d-SOME_DATA">SOME_DATA</a>: <a href="m.link_formatting.html#this-is-an-url#e-Enum" class="m-doc">Enum</a>
             </dt>
             <dd></dd>
           </dl>