docs: Refactor with more_autodoc.typehints and built-in type links (#42)

DenverCoder1 · web-flow · commit 869087b6a0e1 · 2022-09-05T17:49:12.000-06:00
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -40,8 +40,13 @@
     "sphinxcontrib_trio",
     "enum_tools.autoenum",
     "sphinxext.opengraph",
+    "sphinx_toolbox.more_autodoc.typehints",
 ]
 
+intersphinx_mapping = {
+    "py": ("https://docs.python.org/3", None),
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
diff --git a/docs/source/generate_style_list.py b/docs/source/generate_style_list.py
@@ -36,7 +36,7 @@ def generate_style_list():
             last_col_heading=False,
             style=styles[style],
         )
-        style_heading = f"`{style}`\n" + "~" * len(f"`{style}`")
+        style_heading = f".. _PresetStyle.{style}:\n\n`{style}`\n" + "~" * len(f"`{style}`")
         output_example = indent_all_lines(full + "\n\n" + body_only)
         style_list += f"{style_heading}\n\n.. code-block:: none\n\n{output_example}\n\n"
     # put it all together
diff --git a/docs/source/styles.rst b/docs/source/styles.rst
@@ -5,6 +5,8 @@ Preset styles
 
 .. contents::
 
+.. _PresetStyle.ascii:
+
 `ascii`
 ~~~~~~~
 
@@ -26,6 +28,8 @@ Preset styles
    | 2 | 30   40   35   30 |
    +---+-------------------+
 
+.. _PresetStyle.ascii_borderless:
+
 `ascii_borderless`
 ~~~~~~~~~~~~~~~~~~
 
@@ -41,6 +45,8 @@ Preset styles
      1 | 30   40   35   30  
      2 | 30   40   35   30  
 
+.. _PresetStyle.ascii_box:
+
 `ascii_box`
 ~~~~~~~~~~~
 
@@ -62,6 +68,8 @@ Preset styles
    | 2 | 30 | 40 | 35 | 30 |
    +---+----+----+----+----+
 
+.. _PresetStyle.ascii_compact:
+
 `ascii_compact`
 ~~~~~~~~~~~~~~~
 
@@ -81,6 +89,8 @@ Preset styles
    | 2 | 30   40   35   30 |
    +---+-------------------+
 
+.. _PresetStyle.ascii_double:
+
 `ascii_double`
 ~~~~~~~~~~~~~~
 
@@ -102,6 +112,8 @@ Preset styles
    | 2 | 30   40   35   30 |
    +---+-------------------+
 
+.. _PresetStyle.ascii_minimalist:
+
 `ascii_minimalist`
 ~~~~~~~~~~~~~~~~~~
 
@@ -123,6 +135,8 @@ Preset styles
      2 | 30   40   35   30  
     ----------------------- 
 
+.. _PresetStyle.ascii_simple:
+
 `ascii_simple`
 ~~~~~~~~~~~~~~
 
@@ -142,6 +156,8 @@ Preset styles
      2 | 30   40   35   30  
     === ==== ==== ==== ==== 
 
+.. _PresetStyle.borderless:
+
 `borderless`
 ~~~~~~~~~~~~
 
@@ -157,6 +173,8 @@ Preset styles
      1 ┃ 30   40   35   30  
      2 ┃ 30   40   35   30  
 
+.. _PresetStyle.double:
+
 `double`
 ~~~~~~~~
 
@@ -178,6 +196,8 @@ Preset styles
    ║ 2 ║ 30   40   35   30 ║
    ╚═══╩═══════════════════╝
 
+.. _PresetStyle.double_box:
+
 `double_box`
 ~~~~~~~~~~~~
 
@@ -199,6 +219,8 @@ Preset styles
    ║ 2 ║ 30 ║ 40 ║ 35 ║ 30 ║
    ╚═══╩════╩════╩════╩════╝
 
+.. _PresetStyle.double_compact:
+
 `double_compact`
 ~~~~~~~~~~~~~~~~
 
@@ -218,6 +240,8 @@ Preset styles
    ║ 2 ║ 30   40   35   30 ║
    ╚═══╩═══════════════════╝
 
+.. _PresetStyle.double_thin_compact:
+
 `double_thin_compact`
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -237,6 +261,8 @@ Preset styles
    ║ 2 ║ 30   40   35   30 ║
    ╚═══╩═══════════════════╝
 
+.. _PresetStyle.markdown:
+
 `markdown`
 ~~~~~~~~~~
 
@@ -252,6 +278,8 @@ Preset styles
    | 1 | 30 | 40 | 35 | 30 |
    | 2 | 30 | 40 | 35 | 30 |
 
+.. _PresetStyle.minimalist:
+
 `minimalist`
 ~~~~~~~~~~~~
 
@@ -273,6 +301,8 @@ Preset styles
      2 │ 30   40   35   30  
     ─────────────────────── 
 
+.. _PresetStyle.simple:
+
 `simple`
 ~~~~~~~~
 
@@ -292,6 +322,8 @@ Preset styles
      2 ║ 30   40   35   30  
     ═══ ════ ════ ════ ════ 
 
+.. _PresetStyle.thick:
+
 `thick`
 ~~~~~~~
 
@@ -313,6 +345,8 @@ Preset styles
    ┃ 2 ┃ 30   40   35   30 ┃
    ┗━━━┻━━━━━━━━━━━━━━━━━━━┛
 
+.. _PresetStyle.thick_box:
+
 `thick_box`
 ~~~~~~~~~~~
 
@@ -334,6 +368,8 @@ Preset styles
    ┃ 2 ┃ 30 ┃ 40 ┃ 35 ┃ 30 ┃
    ┗━━━┻━━━━┻━━━━┻━━━━┻━━━━┛
 
+.. _PresetStyle.thick_compact:
+
 `thick_compact`
 ~~~~~~~~~~~~~~~
 
@@ -353,6 +389,8 @@ Preset styles
    ┃ 2 ┃ 30   40   35   30 ┃
    ┗━━━┻━━━━━━━━━━━━━━━━━━━┛
 
+.. _PresetStyle.thin:
+
 `thin`
 ~~~~~~
 
@@ -374,6 +412,8 @@ Preset styles
    │ 2 │ 30   40   35   30 │
    └───┴───────────────────┘
 
+.. _PresetStyle.thin_box:
+
 `thin_box`
 ~~~~~~~~~~
 
@@ -395,6 +435,8 @@ Preset styles
    │ 2 │ 30 │ 40 │ 35 │ 30 │
    └───┴────┴────┴────┴────┘
 
+.. _PresetStyle.thin_compact:
+
 `thin_compact`
 ~~~~~~~~~~~~~~
 
@@ -414,6 +456,8 @@ Preset styles
    │ 2 │ 30   40   35   30 │
    └───┴───────────────────┘
 
+.. _PresetStyle.thin_compact_rounded:
+
 `thin_compact_rounded`
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -433,6 +477,8 @@ Preset styles
    │ 2 │ 30   40   35   30 │
    ╰───┴───────────────────╯
 
+.. _PresetStyle.thin_double:
+
 `thin_double`
 ~~~~~~~~~~~~~
 
@@ -454,6 +500,8 @@ Preset styles
    │ 2 │ 30   40   35   30 │
    └───┴───────────────────┘
 
+.. _PresetStyle.thin_double_rounded:
+
 `thin_double_rounded`
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -475,6 +523,8 @@ Preset styles
    │ 2 │ 30   40   35   30 │
    ╰───┴───────────────────╯
 
+.. _PresetStyle.thin_rounded:
+
 `thin_rounded`
 ~~~~~~~~~~~~~~
 
@@ -496,6 +546,8 @@ Preset styles
    │ 2 │ 30   40   35   30 │
    ╰───┴───────────────────╯
 
+.. _PresetStyle.thin_thick:
+
 `thin_thick`
 ~~~~~~~~~~~~
 
@@ -517,6 +569,8 @@ Preset styles
    │ 2 │ 30   40   35   30 │
    └───┴───────────────────┘
 
+.. _PresetStyle.thin_thick_rounded:
+
 `thin_thick_rounded`
 ~~~~~~~~~~~~~~~~~~~~
 
diff --git a/table2ascii/table_style.py b/table2ascii/table_style.py
@@ -65,10 +65,10 @@ def from_string(cls, string: str) -> "TableStyle":
         Create a TableStyle from a string
 
         Args:
-            string (:class:`str`): The string to create the TableStyle from
+            string: The string to create the TableStyle from
 
         Returns:
-            :class:`TableStyle`: A TableStyle object
+            A TableStyle object
 
         Example::
 
diff --git a/table2ascii/table_to_ascii.py b/table2ascii/table_to_ascii.py

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ def generate_style_list():`
`36`	`36`	`last_col_heading=False,`
`37`	`37`	`style=styles[style],`
`38`	`38`	`)`
`39`		- style_heading = f"`{style}`\n" + "~" * len(f"`{style}`")
	`39`	+ style_heading = f".. _PresetStyle.{style}:\n\n`{style}`\n" + "~" * len(f"`{style}`")
`40`	`40`	`output_example = indent_all_lines(full + "\n\n" + body_only)`
`41`	`41`	`style_list += f"{style_heading}\n\n.. code-block:: none\n\n{output_example}\n\n"`
`42`	`42`	`# put it all together`