Merge pull request #24 from menckend/main

Merge pull request #23 from menckend/test

README.md

@@ -2,10 +2,10 @@
 
 I wrote this package (dcnodatg) specifically to assist in *fast/low-effort* modeling of a production EVPN Layer-3 Leaf & Spine physical network of Arista switches in a pre-existing GNS3 server, using Arista cEOS docker images.  (Also, to teach myself how to write/publish Python packages, but *really* for modeling Arista switches.)
 
-- Documentation at: [https://menckend.github.io/dcnodatg/](https://menckend.github.io/dcnodatg/)
-- Repository at: [https://github.com/menckend/dcnodatg](https://github.com/menckend/dcnodatg)
-- (Latest) Package at: [https://pypi.org/project/dcnodatg/](https://pypi.org/project/dcnodatg/)
-- (testing) Package at: [https://test.pypi.org/project/dcnodatg/](https://test.pypi.org/project/dcnodatg/)
+- [Documentation](https://menckend.github.io/dcnodatg/)
+- [Repository](https://github.com/menckend/dcnodatg)
+- [(Latest) Package](https://pypi.org/project/dcnodatg/)
+- [(testing) Package](https://test.pypi.org/project/dcnodatg/)
 
 ## What it does
 

docs/conf.py

@@ -30,6 +30,7 @@
     'sphinx.ext.intersphinx',  # Link to other project's documentation (see mapping below)
     'sphinx.ext.viewcode',  # Add a link to the Python source code for classes, functions etc.
     'sphinx_autodoc_typehints', # Automatically document param types (less noise in class signature)
+    'sphinx.ext.autodoc.typehints',
     'autoapi.extension'
     ]
 
@@ -38,7 +39,7 @@
 exclude_patterns = ['_build', '_templates', 'Thumbs.db', '.DS_Store']
 html_show_sourcelink = False  # Remove 'view source code' from top of page (for html, not python)
 html_theme = 'sphinx_rtd_theme'
-autodoc_typehints = "signature"
+autodoc_typehints = "description"
 autoapi_template_dir = "_templates/autoapi"
 #autodoc_class_signature = "separated"
 autoapi_own_page_level = "function"
@@ -95,7 +96,7 @@ def prepare_jinja_env(jinja_env) -> None:
     # Toc options
     'collapse_navigation': True,
     'sticky_navigation': True,
-    'navigation_depth': 5,
+    'navigation_depth': -1,
     'includehidden': True,
     'titles_only': False
 }