DOC: configured auto-generation of API docs

README.rst

@@ -1,15 +1,13 @@
-dserver
-=======
+dtool-lookup-server, or short "dserver"
+=======================================
 
 .. image:: icons/22x22/dtool_logo.png
     :height: 20px
     :target: https://github.com/livMatS/dtool-lookup-server
     :alt: dtool icon
-
 .. image:: https://badge.fury.io/py/dtool-lookup-server.svg
    :target: http://badge.fury.io/py/dtool-lookup-server
    :alt: PyPi package
-
 .. image:: https://img.shields.io/github/actions/workflow/status/livMatS/dtool-lookup-server/test.yml?branch=main
     :target: https://github.com/livMatS/dtool-lookup-gui/actions/workflows/test.yml
     :alt: GitHub Workflow Status

docs/conf.py

@@ -26,14 +26,23 @@
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
 
+# -- Extension configuration -------------------------------------------------
+
+autodoc_default_options = {
+    'members': True,
+    'member-order': 'bysource',
+    'undoc-members': True,
+    'show-inheritance': True,
+    'inherited-members': True,
+    'special-members': '__init__',
+}
+
 # spell check with sphinxcontrib.spelling
 spelling_lang = 'en_US'
 spelling_show_suggestions = True

docs/index.rst

@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-dserver, the dtool lookup server
-================================
+dtool-lookup-server, short "dserver"
+====================================
 
 .. toctree::
    :maxdepth: 2