DOC,BLD: improve API part of documentation

Skip `sphinxcontrib-apiref` and introduce `autoclasstoc` and manual entries with `autoclass` instead
jorge-epm · Sep 1, 2021 · ed3e99b · ed3e99b
1 parent 9e797e6
commit ed3e99b
Show file tree

Hide file tree

Showing 14 changed files with 472 additions and 239 deletions.
diff --git a/.gitignore b/.gitignore
@@ -60,7 +60,7 @@ _tmp_*
 
 # Sphinx documentation
 docs/_build
-docs/apiref
+docs/_apiref
 
 # PyBuilder
 target/

diff --git a/docs/_static/theme_overrides.css b/docs/_static/theme_overrides.css
@@ -0,0 +1,14 @@
+/* override table width restrictions */
+/* see https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html */
+@media screen and (min-width: 767px) {
+
+   .wy-table-responsive table td {
+      /* !important prevents the common CSS stylesheets from overriding
+         this as on RTD they are loaded after this stylesheet */
+      white-space: normal !important;
+   }
+
+   .wy-table-responsive {
+      overflow: visible !important;
+   }
+}
diff --git a/docs/_templates/custom-class-template.rst b/docs/_templates/custom-class-template.rst
@@ -0,0 +1,10 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+   .. autoclasstoc::