transform

Author: kwankyu

src/doc/common/static/custom-furo.css

@@ -21,3 +21,9 @@ a.pdf:hover {
   text-decoration: none;
 }
 
+
+/* For INPUT:, OUTPUT:, EXAMPLES */
+
+abbr {
+  font-weight: 500;
+}

src/sage_docbuild/conf.py

@@ -852,6 +852,55 @@ def apply(self):
 
                     node.parent.insert(node.parent.index(node) + 1, cell_node)
 
+class AuthorsTransform(SphinxTransform):
+    default_priority = 800
+
+    def apply(self):
+        for node in self.document.traverse(nodes.paragraph):
+            if isinstance(node.children[0], nodes.Text) and node.children[0].astext().strip() == 'AUTHORS:':
+                list_node = node.next_node(siblings=True, descend=False)
+                if isinstance(list_node, nodes.bullet_list):
+                    new_node = nodes.admonition(classes=['authors'], admonitionclass='authors')
+                    node.replace_self(new_node)
+                    node = new_node
+                    admonition_title = nodes.title()
+                    admonition_title.append(nodes.Text('Authors'))
+                    node.insert(0, admonition_title)
+                    node.append(list_node)
+                    node.parent.remove(list_node)
+            if isinstance(node.children[0], nodes.Text) and node.children[0].astext().startswith('INPUT:'):
+                parent = node.parent
+                index = parent.index(node)
+                parent.remove(node)
+                parent.insert(index, nodes.Text(node.children[0].astext()[len('INPUT:'):]))
+                acronym_node = nodes.acronym()
+                acronym_node += nodes.Text("INPUT")
+                parent.insert(index, acronym_node)
+            if isinstance(node.children[0], nodes.Text) and node.children[0].astext().startswith('OUTPUT:'):
+                parent = node.parent
+                index = parent.index(node)
+                parent.remove(node)
+                parent.insert(index, nodes.Text(node.children[0].astext()[len('OUTPUT:'):]))
+                acronym_node = nodes.acronym()
+                acronym_node += nodes.Text("OUTPUT")
+                parent.insert(index, acronym_node)
+            if isinstance(node.children[0], nodes.Text) and node.children[0].astext().startswith('EXAMPLES:'):
+                parent = node.parent
+                index = parent.index(node)
+                parent.remove(node)
+                parent.insert(index, nodes.Text(node.children[0].astext()[len('EXAMPLES:'):]))
+                acronym_node = nodes.acronym()
+                acronym_node += nodes.Text("EXAMPLES")
+                parent.insert(index, acronym_node)
+            if isinstance(node.children[0], nodes.Text) and node.children[0].astext().startswith('EXAMPLE:'):
+                parent = node.parent
+                index = parent.index(node)
+                parent.remove(node)
+                parent.insert(index, nodes.Text(node.children[0].astext()[len('EXAMPLE:'):]))
+                acronym_node = nodes.acronym()
+                acronym_node += nodes.Text("EXAMPLE")
+                parent.insert(index, acronym_node)
+
 
 # This replaces the setup() in sage.misc.sagedoc_conf
 def setup(app):
@@ -864,6 +913,7 @@ def setup(app):
         app.connect('autodoc-process-docstring', skip_TESTS_block)
     app.connect('autodoc-skip-member', skip_member)
     app.add_transform(SagemathTransform)
+    app.add_transform(AuthorsTransform)
     if os.environ.get('SAGE_LIVE_DOC', 'no') == 'yes':
         app.add_transform(SagecodeTransform)