move repeat doc config to conf

uqfoundation · Feb 5, 2023 · fb38aa9 · fb38aa9
1 parent a5bad3d
commit fb38aa9
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 58 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -57,16 +57,34 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'ppft'
+project = 'ppft'
 year = datetime.now().year
-copyright = u'%d, The Uncertainty Quantification Foundation' % year
-author = u'Mike McKerns'
+copyright = '%d, The Uncertainty Quantification Foundation' % year
+author = 'Mike McKerns'
 
 # extension config
 github_project_url = "https://github.com/uqfoundation/ppft"
 autoclass_content = 'both'
+autodoc_default_options = {
+    'members': True,
+    'undoc-members': True,
+    'private-members': True,
+    'special-members': True,
+    'show-inheritance': True,
+    'imported-members': True,
+    'exclude-members': (
+        '__dict__,'
+        '__slots__,'
+        '__weakref__,'
+        '__module__,'
+        '_abc_impl,'
+        '__init__,'
+        '__annotations__,'
+        '__dataclass_fields__,'
+    )
+}
 autodoc_typehints = 'description'
-napoleon_include_init_with_doc = True
+autodoc_typehints_format = 'short'
 napoleon_include_private_with_doc = False
 napoleon_include_special_with_doc = True
 napoleon_use_ivar = True
@@ -86,7 +104,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -191,8 +209,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'ppft.tex', u'ppft Documentation',
-     u'Mike McKerns', 'manual'),
+    (master_doc, 'ppft.tex', 'ppft Documentation',
+     'Mike McKerns', 'manual'),
 ]
 
 
@@ -201,7 +219,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'ppft', u'ppft Documentation',
+    (master_doc, 'ppft', 'ppft Documentation',
      [author], 1)
 ]
 
@@ -212,7 +230,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'ppft', u'ppft Documentation',
+    (master_doc, 'ppft', 'ppft Documentation',
      author, 'ppft', 'Distributed and parallel python.',
      'Miscellaneous'),
 ]

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,12 +4,7 @@ ppft package documentation
 ==========================
 
 .. automodule:: ppft
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
+..  :exclude-members: +
 
 .. toctree::
     :maxdepth: 2

diff --git a/docs/source/ppft.rst b/docs/source/ppft.rst
@@ -5,59 +5,28 @@ auto module
 -----------
 
 .. automodule:: ppft.auto
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
+..  :exclude-members: +
 
 common module
 -------------
 
 .. automodule:: ppft.common
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
+..  :exclude-members: +
 
 server module
 -------------
 
 .. automodule:: ppft.server
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
+..  :exclude-members: +
 
 transport module
 ----------------
 
 .. automodule:: ppft.transport
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
+..  :exclude-members: +
 
 worker module
 -------------
 
 .. automodule:: ppft.worker
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
-
+..  :exclude-members: +
diff --git a/docs/source/scripts.rst b/docs/source/scripts.rst
@@ -5,10 +5,4 @@ ppserver script
 ---------------
 
 .. automodule:: _ppserver
-    :members:
-    :undoc-members:
-    :private-members:
-    :special-members:
-    :show-inheritance:
-    :imported-members:
-..  :exclude-members:
+..  :exclude-members: +