update inheritance diagrams (#1248)

* update inheritance diagrams * update release notes * fix layout * fix release notes * fix docs Co-authored-by: bchen1116 <bryan.chen@alteryx.com>
alteryx · Oct 1, 2020 · 8cdfe14 · 8cdfe14
1 parent d04dba7
commit 8cdfe14
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 26 deletions.
diff --git a/docs/source/_static/style.css b/docs/source/_static/style.css
@@ -1,11 +1,4 @@
 div.graphviz {
     overflow: auto;
-    max-width: 620px;
-    max-height: 50px;
-    text-align: center;
+    text-align: left;
 }
-
-img.inheritance { 
-      max-width: none;
-      max-height: 30px;
-}  
diff --git a/docs/source/_templates/class.rst b/docs/source/_templates/class.rst
@@ -2,8 +2,6 @@
 
 .. currentmodule:: {{ module }}
 
-.. inheritance-diagram:: {{ objname }}
-
 .. autoclass:: {{ objname }}
    {% block methods %}
    {% if methods %}
@@ -18,3 +16,8 @@
    {%- endfor %}
    {% endif %}
    {% endblock %}
+
+Class Inheritance
+"""""""""""""""""
+
+.. inheritance-diagram:: {{ objname }}
diff --git a/docs/source/_templates/class_with_properties.rst b/docs/source/_templates/class_with_properties.rst
@@ -2,8 +2,6 @@
 
 .. currentmodule:: {{ module }}
 
-.. inheritance-diagram:: {{ objname }}
-
 .. autoclass:: {{ objname }}
    {% block methods %}
    {% if methods %}
@@ -29,3 +27,8 @@
       ~{{ name }}.{{ item }}
    {%- endfor %}
    {% endblock %}
+
+Class Inheritance
+"""""""""""""""""
+
+.. inheritance-diagram:: {{ objname }}
diff --git a/docs/source/_templates/data_check_class.rst b/docs/source/_templates/data_check_class.rst
@@ -2,8 +2,6 @@
 
 .. currentmodule:: {{ module }}
 
-.. inheritance-diagram:: {{ objname }}
-
 .. autoclass:: {{ objname }}
    {% set class_attributes = ['name'] %}
 
@@ -41,3 +39,8 @@
    {%- endfor %}
    {% endif %}
    {% endblock %}
+
+Class Inheritance
+"""""""""""""""""
+
+.. inheritance-diagram:: {{ objname }}
diff --git a/docs/source/_templates/data_check_message.rst b/docs/source/_templates/data_check_message.rst
@@ -2,8 +2,6 @@
 
 .. currentmodule:: {{ module }}
 
-.. inheritance-diagram:: {{ objname }}
-
 .. autoclass:: {{ objname }}
    {% set class_attributes = ['message_type'] %}
    {% set special_methods = ['__str__', '__eq__'] %}
@@ -34,3 +32,8 @@
    {%- endfor %}
    {% endif %}
    {% endblock %}
+
+Class Inheritance
+"""""""""""""""""
+
+.. inheritance-diagram:: {{ objname }}
diff --git a/docs/source/_templates/estimator_class.rst b/docs/source/_templates/estimator_class.rst
@@ -2,8 +2,6 @@
 
 .. currentmodule:: {{ module }}
 
-.. inheritance-diagram:: {{ objname }}
-
 .. autoclass:: {{ objname }}
    {% set class_attributes = ['name', 'model_family', 'hyperparameter_ranges', 'supported_problem_types',
                               'default_parameters'] %}
@@ -43,3 +41,8 @@
    {%- endfor %}
    {% endif %}
    {% endblock %}
+
+Class Inheritance
+"""""""""""""""""
+
+.. inheritance-diagram:: {{ objname }}
diff --git a/docs/source/_templates/pipeline_base_class.rst b/docs/source/_templates/pipeline_base_class.rst
@@ -2,8 +2,6 @@
 
 .. currentmodule:: {{ module }}
 
-.. inheritance-diagram:: {{ objname }}
-
 .. autoclass:: {{ objname }}
    {% set class_attributes = ['name', 'custom_name', 'summary', 'component_graph', 'problem_type',
                               'model_family', 'hyperparameters', 'custom_hyperparameters',
@@ -45,3 +43,8 @@
    {%- endfor %}
    {% endif %}
    {% endblock %}
+
+Class Inheritance
+"""""""""""""""""
+
+.. inheritance-diagram:: {{ objname }}
diff --git a/docs/source/_templates/pipeline_class.rst b/docs/source/_templates/pipeline_class.rst
@@ -2,8 +2,6 @@
 
 .. currentmodule:: {{ module }}
 
-.. inheritance-diagram:: {{ objname }}
-
 .. autoclass:: {{ objname }}
    {% set class_attributes = ['name', 'custom_name', 'summary', 'component_graph', 'problem_type',
                               'model_family', 'hyperparameters', 'custom_hyperparameters',
@@ -50,3 +48,8 @@
    {%- endfor %}
    {% endif %}
    {% endblock %}
+
+Class Inheritance
+"""""""""""""""""
+
+.. inheritance-diagram:: {{ objname }}
diff --git a/docs/source/_templates/transformer_class.rst b/docs/source/_templates/transformer_class.rst
@@ -2,8 +2,6 @@
 
 .. currentmodule:: {{ module }}
 
-.. inheritance-diagram:: {{ objname }}
-
 .. autoclass:: {{ objname }}
 
    {% set class_attributes = ['name', 'model_family', 'hyperparameter_ranges', 'default_parameters'] %}
@@ -42,3 +40,8 @@
    {%- endfor %}
    {% endif %}
    {% endblock %}
+
+Class Inheritance
+"""""""""""""""""
+
+.. inheritance-diagram:: {{ objname }}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -214,8 +214,9 @@
 nbsphinx_execute = 'always'
 nbsphinx_timeout = 600 # sphinx defaults each cell to 30 seconds so we need to override here
 
-inheritance_graph_attrs = dict(rankdir="LR", size='"1000, 333"',
-                               fontsize=30, labelfontsize=30, ratio='compress', dpi=960)
+inheritance_graph_attrs = dict(rankdir="TB", dpi=192.0, ranksep=0.02)
+inheritance_node_attrs = dict(fontsize=6, height=0.15, width=5, fixedsize=True)
+inheritance_edge_attrs = dict(arrowsize=0.1)
 
 class AccessorLevelDocumenter(Documenter):
     """

diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst
@@ -9,6 +9,7 @@ Release Notes
     * Documentation Changes
         * Fixed and updated code blocks in Release Notes :pr:`1243`
         * Added DecisionTree estimators to API Reference :pr:`1246`
+        * Changed class inheritance display to flow vertically :pr:`1248`
     * Testing Changes