docs: Preview color constants

Makes the `color` module page a lot more colorful!

Signed-off-by: Rahix <rahix@rahix.de>

Documentation/conf.py

@@ -3,6 +3,8 @@ import subprocess
 import sys
 import time
 import sphinx.util.logging
+from docutils import nodes
+from docutils.parsers import rst
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -47,6 +49,21 @@ todo_include_todos = True
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["output", "Thumbs.db", ".DS_Store", "hawkmoth"]
 
+# -- Extensions -------------------------------------------------------------- {{{
+
+
+class ColorExample(rst.Directive):
+    has_content = False
+    required_arguments = 1
+    optional_arguments = 0
+    option_spec = {}
+
+    def run(self):
+        color = self.arguments[0]
+        html_text = '<div style="width: 30px;height: 30px;background: {};border: black 1px solid;border-radius: 15px;"></div>'
+        return [nodes.raw("", html_text.format(color), format="html")]
+# }}}
+
 # -- Options for HTML output ------------------------------------------------- {{{
 
 # The Read the Docs theme is available from
@@ -125,3 +142,4 @@ except ImportError as e:
 # -- Sphinx Setup ------------------------------------------------------------
 def setup(app):
     app.add_config_value("has_hawkmoth", has_hawkmoth, "")
+    app.add_directive("color-example", ColorExample)

Documentation/pycardium/color.rst

@@ -14,23 +14,65 @@ The color module also contains a few constanst for commonly used colors:
 Camp Colors
 ~~~~~~~~~~~
 .. py:data:: CHAOSBLUE
+
+   .. color-example:: #0076BA
+
 .. py:data:: CHAOSBLUE_DARK
+
+   .. color-example:: #005383
+
 .. py:data:: COMMYELLOW
+
+   .. color-example:: #FFC600
+
 .. py:data:: COMMYELLOW_DARK
+
+   .. color-example:: #D39A00
+
 .. py:data:: CAMPGREEN
+
+   .. color-example:: #99BA00
+
 .. py:data:: CAMPGREEN_DARK
 
+   .. color-example:: #6F8700
+
+
 General
 ~~~~~~~
 .. py:data:: BLACK
+
+   .. color-example:: #000
+
 .. py:data:: WHITE
+
+   .. color-example:: #fff
+
 .. py:data:: RED
+
+   .. color-example:: #f00
+
 .. py:data:: GREEN
+
+   .. color-example:: #0f0
+
 .. py:data:: YELLOW
+
+   .. color-example:: #ff0
+
 .. py:data:: BLUE
+
+   .. color-example:: #00f
+
 .. py:data:: MAGENTA
+
+   .. color-example:: #f0f
+
 .. py:data:: CYAN
 
+   .. color-example:: #0ff
+
+
 .. py:module:: htmlcolor
 
 ``htmlcolor`` - Color Constants
@@ -39,142 +81,561 @@ The ``htmlcolor`` module contains even more color constants.  Note
 that loading the ``htmlcolor`` module will require ~12K of RAM.
 
 .. py:data:: ALICEBLUE
+
+   .. color-example:: aliceblue
+
 .. py:data:: ANTIQUEWHITE
+
+   .. color-example:: antiquewhite
+
 .. py:data:: AQUA
+
+   .. color-example:: aqua
+
 .. py:data:: AQUAMARINE
+
+   .. color-example:: aquamarine
+
 .. py:data:: AZURE
+
+   .. color-example:: azure
+
 .. py:data:: BEIGE
+
+   .. color-example:: beige
+
 .. py:data:: BISQUE
+
+   .. color-example:: bisque
+
 .. py:data:: BLACK
+
+   .. color-example:: black
+
 .. py:data:: BLANCHEDALMOND
+
+   .. color-example:: blanchedalmond
+
 .. py:data:: BLUE
+
+   .. color-example:: blue
+
 .. py:data:: BLUEVIOLET
+
+   .. color-example:: blueviolet
+
 .. py:data:: BROWN
+
+   .. color-example:: brown
+
 .. py:data:: BURLYWOOD
+
+   .. color-example:: burlywood
+
 .. py:data:: CADETBLUE
+
+   .. color-example:: cadetblue
+
 .. py:data:: CHARTREUSE
+
+   .. color-example:: chartreuse
+
 .. py:data:: CHOCOLATE
+
+   .. color-example:: chocolate
+
 .. py:data:: CORAL
+
+   .. color-example:: coral
+
 .. py:data:: CORNFLOWERBLUE
+
+   .. color-example:: cornflowerblue
+
 .. py:data:: CORNSILK
+
+   .. color-example:: cornsilk
+
 .. py:data:: CRIMSON
+
+   .. color-example:: crimson
+
 .. py:data:: CYAN
+
+   .. color-example:: cyan
+
 .. py:data:: DARKBLUE
+
+   .. color-example:: darkblue
+
 .. py:data:: DARKCYAN
+
+   .. color-example:: darkcyan
+
 .. py:data:: DARKGOLDENROD
+
+   .. color-example:: darkgoldenrod
+
 .. py:data:: DARKGRAY
+
+   .. color-example:: darkgray
+
 .. py:data:: DARKGREEN
+
+   .. color-example:: darkgreen
+
 .. py:data:: DARKKHAKI
+
+   .. color-example:: darkkhaki
+
 .. py:data:: DARKMAGENTA
+
+   .. color-example:: darkmagenta
+
 .. py:data:: DARKOLIVEGREEN
+
+   .. color-example:: darkolivegreen
+
 .. py:data:: DARKORANGE
+
+   .. color-example:: darkorange
+
 .. py:data:: DARKORCHID
+
+   .. color-example:: darkorchid
+
 .. py:data:: DARKRED
+
+   .. color-example:: darkred
+
 .. py:data:: DARKSALMON
+
+   .. color-example:: darksalmon
+
 .. py:data:: DARKSEAGREEN
+
+   .. color-example:: darkseagreen
+
 .. py:data:: DARKSLATEBLUE
+
+   .. color-example:: darkslateblue
+
 .. py:data:: DARKSLATEGRAY
+
+   .. color-example:: darkslategray
+
 .. py:data:: DARKTURQUOISE
+
+   .. color-example:: darkturquoise
+
 .. py:data:: DARKVIOLET
+
+   .. color-example:: darkviolet
+
 .. py:data:: DEEPPINK
+
+   .. color-example:: deeppink
+
 .. py:data:: DEEPSKYBLUE
+
+   .. color-example:: deepskyblue
+
 .. py:data:: DIMGRAY
+
+   .. color-example:: dimgray
+
 .. py:data:: DODGERBLUE
+
+   .. color-example:: dodgerblue
+
 .. py:data:: FIREBRICK
+
+   .. color-example:: firebrick
+
 .. py:data:: FLORALWHITE
+
+   .. color-example:: floralwhite
+
 .. py:data:: FORESTGREEN
+
+   .. color-example:: forestgreen
+
 .. py:data:: FUCHSIA
+
+   .. color-example:: fuchsia
+
 .. py:data:: GAINSBORO
+
+   .. color-example:: gainsboro
+
 .. py:data:: GHOSTWHITE
+
+   .. color-example:: ghostwhite
+
 .. py:data:: GOLD
+
+   .. color-example:: gold
+
 .. py:data:: GOLDENROD
+
+   .. color-example:: goldenrod
+
 .. py:data:: GRAY
+
+   .. color-example:: gray
+
 .. py:data:: GREEN
+
+   .. color-example:: green
+
 .. py:data:: GREENYELLOW
+
+   .. color-example:: greenyellow
+
 .. py:data:: HONEYDEW
+
+   .. color-example:: honeydew
+
 .. py:data:: HOTPINK
+
+   .. color-example:: hotpink
+
 .. py:data:: INDIANRED
+
+   .. color-example:: indianred
+
 .. py:data:: INDIGO
+
+   .. color-example:: indigo
+
 .. py:data:: IVORY
+
+   .. color-example:: ivory
+
 .. py:data:: KHAKI
+
+   .. color-example:: khaki
+
 .. py:data:: LAVENDER
+
+   .. color-example:: lavender
+
 .. py:data:: LAVENDERBLUSH
+
+   .. color-example:: lavenderblush
+
 .. py:data:: LAWNGREEN
+
+   .. color-example:: lawngreen
+
 .. py:data:: LEMONCHIFFON
+
+   .. color-example:: lemonchiffon
+
 .. py:data:: LIGHTBLUE
+
+   .. color-example:: lightblue
+
 .. py:data:: LIGHTCORAL
+
+   .. color-example:: lightcoral
+
 .. py:data:: LIGHTCYAN
+
+   .. color-example:: lightcyan
+
 .. py:data:: LIGHTGOLDENRODYELLOW
+
+   .. color-example:: lightgoldenrodyellow
+
 .. py:data:: LIGHTGRAY
+
+   .. color-example:: lightgray
+
 .. py:data:: LIGHTGREEN
+
+   .. color-example:: lightgreen
+
 .. py:data:: LIGHTPINK
+
+   .. color-example:: lightpink
+
 .. py:data:: LIGHTSALMON
+
+   .. color-example:: lightsalmon
+
 .. py:data:: LIGHTSEAGREEN
+
+   .. color-example:: lightseagreen
+
 .. py:data:: LIGHTSKYBLUE
+
+   .. color-example:: lightskyblue
+
 .. py:data:: LIGHTSLATEGRAY
+
+   .. color-example:: lightslategray
+
 .. py:data:: LIGHTSTEELBLUE
+
+   .. color-example:: lightsteelblue
+
 .. py:data:: LIGHTYELLOW
+
+   .. color-example:: lightyellow
+
 .. py:data:: LIME
+
+   .. color-example:: lime
+
 .. py:data:: LIMEGREEN
+
+   .. color-example:: limegreen
+
 .. py:data:: LINEN
+
+   .. color-example:: linen
+
 .. py:data:: MAGENTA
+
+   .. color-example:: magenta
+
 .. py:data:: MAROON
+
+   .. color-example:: maroon
+
 .. py:data:: MEDIUMAQUAMARINE
+
+   .. color-example:: mediumaquamarine
+
 .. py:data:: MEDIUMBLUE
+
+   .. color-example:: mediumblue
+
 .. py:data:: MEDIUMORCHID
+
+   .. color-example:: mediumorchid
+
 .. py:data:: MEDIUMPURPLE
+
+   .. color-example:: mediumpurple
+
 .. py:data:: MEDIUMSEAGREEN
+
+   .. color-example:: mediumseagreen
+
 .. py:data:: MEDIUMSLATEBLUE
+
+   .. color-example:: mediumslateblue
+
 .. py:data:: MEDIUMSPRINGGREEN
+
+   .. color-example:: mediumspringgreen
+
 .. py:data:: MEDIUMTURQUOISE
+
+   .. color-example:: mediumturquoise
+
 .. py:data:: MEDIUMVIOLETRED
+
+   .. color-example:: mediumvioletred
+
 .. py:data:: MIDNIGHTBLUE
+
+   .. color-example:: midnightblue
+
 .. py:data:: MINTCREAM
+
+   .. color-example:: mintcream
+
 .. py:data:: MISTYROSE
+
+   .. color-example:: mistyrose
+
 .. py:data:: MOCCASIN
+
+   .. color-example:: moccasin
+
 .. py:data:: NAVAJOWHITE
+
+   .. color-example:: navajowhite
+
 .. py:data:: NAVY
+
+   .. color-example:: navy
+
 .. py:data:: OLDLACE
+
+   .. color-example:: oldlace
+
 .. py:data:: OLIVE
+
+   .. color-example:: olive
+
 .. py:data:: OLIVEDRAB
+
+   .. color-example:: olivedrab
+
 .. py:data:: ORANGE
+
+   .. color-example:: orange
+
 .. py:data:: ORANGERED
+
+   .. color-example:: orangered
+
 .. py:data:: ORCHID
+
+   .. color-example:: orchid
+
 .. py:data:: PALEGOLDENROD
+
+   .. color-example:: palegoldenrod
+
 .. py:data:: PALEGREEN
+
+   .. color-example:: palegreen
+
 .. py:data:: PALETURQUOISE
+
+   .. color-example:: paleturquoise
+
 .. py:data:: PALEVIOLETRED
+
+   .. color-example:: palevioletred
+
 .. py:data:: PAPAYAWHIP
+
+   .. color-example:: papayawhip
+
 .. py:data:: PEACHPUFF
+
+   .. color-example:: peachpuff
+
 .. py:data:: PERU
+
+   .. color-example:: peru
+
 .. py:data:: PINK
+
+   .. color-example:: pink
+
 .. py:data:: PLUM
+
+   .. color-example:: plum
+
 .. py:data:: POWDERBLUE
+
+   .. color-example:: powderblue
+
 .. py:data:: PURPLE
+
+   .. color-example:: purple
+
 .. py:data:: RED
+
+   .. color-example:: red
+
 .. py:data:: ROSYBROWN
+
+   .. color-example:: rosybrown
+
 .. py:data:: ROYALBLUE
+
+   .. color-example:: royalblue
+
 .. py:data:: SADDLEBROWN
+
+   .. color-example:: saddlebrown
+
 .. py:data:: SALMON
+
+   .. color-example:: salmon
+
 .. py:data:: SANDYBROWN
+
+   .. color-example:: sandybrown
+
 .. py:data:: SEAGREEN
+
+   .. color-example:: seagreen
+
 .. py:data:: SEASHELL
+
+   .. color-example:: seashell
+
 .. py:data:: SIENNA
+
+   .. color-example:: sienna
+
 .. py:data:: SILVER
+
+   .. color-example:: silver
+
 .. py:data:: SKYBLUE
+
+   .. color-example:: skyblue
+
 .. py:data:: SLATEBLUE
+
+   .. color-example:: slateblue
+
 .. py:data:: SLATEGRAY
+
+   .. color-example:: slategray
+
 .. py:data:: SNOW
+
+   .. color-example:: snow
+
 .. py:data:: SPRINGGREEN
+
+   .. color-example:: springgreen
+
 .. py:data:: STEELBLUE
+
+   .. color-example:: steelblue
+
 .. py:data:: TAN
+
+   .. color-example:: tan
+
 .. py:data:: TEAL
+
+   .. color-example:: teal
+
 .. py:data:: THISTLE
+
+   .. color-example:: thistle
+
 .. py:data:: TOMATO
+
+   .. color-example:: tomato
+
 .. py:data:: TURQUOISE
+
+   .. color-example:: turquoise
+
 .. py:data:: VIOLET
+
+   .. color-example:: violet
+
 .. py:data:: WHEAT
+
+   .. color-example:: wheat
+
 .. py:data:: WHITE
+
+   .. color-example:: white
+
 .. py:data:: WHITESMOKE
+
+   .. color-example:: whitesmoke
+
 .. py:data:: YELLOW
+
+   .. color-example:: yellow
+
 .. py:data:: YELLOWGREEN
+
+   .. color-example:: yellowgreen