Merge pull request #1802 from mhsmith/support-circles

Make API support table circles a more consistent size
beeware · Mar 5, 2023 · 26ed94e · 26ed94e
2 parents 94455b5 + 5b406bd
commit 26ed94e
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 3 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -15,6 +15,7 @@ build:
 sphinx:
   builder: html
   configuration: docs/conf.py
+  fail_on_warning: true
 
 # Build docs as PDF (other options are epub and htmlzip)
 formats:

diff --git a/changes/1802.misc.rst b/changes/1802.misc.rst
@@ -0,0 +1 @@
+Make API support table circles a more consistent size
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -16,3 +16,10 @@ table.docutils {
     font-size: var(--font-size--normal);
     font-weight: bold;
 }
+
+span.beta, span.stable {
+    /* Use fonts where the black and white circles have consistent size and alignment. */
+    font-family: Arial, "Lucida Grande", sans-serif;
+    font-size: x-large;
+    line-height: 1;
+}
diff --git a/docs/conf.py b/docs/conf.py
@@ -100,8 +100,10 @@
 
 # API status indicators.
 rst_prolog = """
-.. |y| replace:: ●
-.. |b| replace:: ○
+.. role:: stable
+.. role:: beta
+.. |y| replace:: :stable:`●`
+.. |b| replace:: :beta:`○`
 """
 
 

diff --git a/docs/reference/style/pack.rst b/docs/reference/style/pack.rst
@@ -11,7 +11,7 @@ properties exist to control color, text alignment and so on.
 It is similar in some ways to the CSS Flexbox algorithm; but dramatically
 simplified, as there is no allowance for overflowing boxes.
 
-.. admonition::
+.. note::
 
    The string values defined here are the string literals that the Pack
    algorithm accepts. These values are also pre-defined as Python constants in