Improve Immaterial documenters (#85)

* Improve Immaterial documenters

* Use concurrency groups

.github/workflows/test.yml

@@ -9,19 +9,14 @@ on:
   schedule:
   - cron: "0 0 * * 0"
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  cancel:
-    name: Cancel previous workflow
-    runs-on: ubuntu-latest
-    steps:
-    - name: Cancel previous runs
-      uses: styfle/[email protected]
-      with:
-        access_token: ${{ github.token }}
 
   docs:
     name: Build docs
-    needs: [cancel]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
@@ -40,7 +35,6 @@ jobs:
 
   lint:
     name: Lint
-    needs: [cancel]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
@@ -61,7 +55,6 @@ jobs:
 
   test:
     name: Test
-    needs: [cancel]
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false

tests/test_graphs_RecordField.py

@@ -3,7 +3,6 @@
 
 
 def test_graphs_RecordField():
-
     graph = Graph()
     graph.node_attributes["shape"] = "record"
 

uqbar/_version.py

@@ -1,2 +1,2 @@
-__version_info__ = (0, 6, 8)
+__version_info__ = (0, 6, 9)
 __version__ = ".".join(str(x) for x in __version_info__)

uqbar/apis/documenters.py

@@ -295,8 +295,13 @@ def __init__(
     def __str__(self) -> str:
         result = self._build_preamble()
         result.extend(self._build_toc(self.module_documenters or []))
+        member_strings: List[str] = []
         for documenter in self._member_documenters:
-            result.extend(["", str(documenter)])
+            member_strings.append(str(documenter))
+        member_strings.sort(key=lambda x: x.partition("\n")[0].split("::"))
+        for member_string in member_strings:
+            result.append("")
+            result.append(member_string)
         return "\n".join(result)
 
     ### PRIVATE METHODS ###

uqbar/apis/summarizers.py

@@ -721,6 +721,7 @@ def __str__(self) -> str:
         if issubclass(self.client, enum.Enum):  # type: ignore
             result.extend(["   :members:", "   :undoc-members:"])
         result.append("")
+        attrs: List[str] = []
         for attr in sorted(
             inspect.classify_class_attrs(cast(type, self.client)), key=lambda x: x.name
         ):
@@ -730,10 +731,15 @@ def __str__(self) -> str:
                 continue
             if attr.name.startswith("__") and attr.name in self.ignored_special_methods:
                 continue
-            if attr.kind in ("method", "class method", "static method"):
-                result.append(f"   .. automethod:: {attr.name}")
-            elif attr.kind in ("property"):
-                result.append(f"   .. autoproperty:: {attr.name}")
+            if attr.kind in ["method", "class method", "static method"]:
+                attrs.append(f"   .. automethod:: {attr.name}")
+            elif attr.kind in ["property"]:
+                attrs.append(f"   .. autoproperty:: {attr.name}")
+            elif attr.kind in ["data"] and isinstance(attr.object, type):
+                attrs.append(
+                    f"   .. autoclass:: {self.client.__module__}::{name}.{attr.name}"
+                )
+        result.extend(sorted(attrs))
         return "\n".join(result)
 
 

uqbar/containers/unique_tree.py

@@ -183,7 +183,6 @@ def root(self):
 
 
 class UniqueTreeContainer(UniqueTreeNode):
-
     ### INITIALIZER ###
 
     def __init__(self, children=None, name=None):

uqbar/graphs/attrs.py

@@ -33,7 +33,6 @@ class Attributes(collections.abc.MutableMapping):
     ### CLASS VARIABLES ###
 
     class Color(object):
-
         __slots__ = ("color",)
 
         def __init__(self, color) -> None:
@@ -54,7 +53,6 @@ class Mode(enum.Enum):
         TABLE_CELL = 6
 
     class Point(object):
-
         __slots__ = ("x", "y")
 
         def __init__(self, x, y) -> None:

uqbar/graphs/core.py

@@ -7,7 +7,6 @@
 
 
 class Attachable(UniqueTreeNode):
-
     ### CLASS VARIABLES ###
 
     __documentation_section__ = "Mixins"

uqbar/graphs/graphers.py

@@ -10,7 +10,6 @@
 
 
 class Grapher:
-
     ### CLASS VARIABLES ###
 
     _valid_formats = ("png", "pdf", "svg")