Skip to content

Commit

Permalink
move repeat doc config to conf
Browse files Browse the repository at this point in the history
  • Loading branch information
mmckerns committed Feb 5, 2023
1 parent 0822da1 commit 993bf7f
Show file tree
Hide file tree
Showing 7 changed files with 58 additions and 213 deletions.
36 changes: 27 additions & 9 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,34 @@
master_doc = 'index'

# General information about the project.
project = u'pathos'
project = 'pathos'
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/pathos"
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
Expand All @@ -87,7 +105,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.
Expand Down Expand Up @@ -192,8 +210,8 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'pathos.tex', u'pathos Documentation',
u'Mike McKerns', 'manual'),
(master_doc, 'pathos.tex', 'pathos Documentation',
'Mike McKerns', 'manual'),
]


Expand All @@ -202,7 +220,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'pathos', u'pathos Documentation',
(master_doc, 'pathos', 'pathos Documentation',
[author], 1)
]

Expand All @@ -213,7 +231,7 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'pathos', u'pathos Documentation',
(master_doc, 'pathos', 'pathos Documentation',
author, 'pathos', 'Parallel graph management and execution in heterogeneous computing.',
'Miscellaneous'),
]
Expand Down
17 changes: 2 additions & 15 deletions docs/source/helpers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,10 @@ mp_helper module
----------------

.. automodule:: pathos.helpers.mp_helper
:members:
:undoc-members:
:private-members:
:special-members:
:show-inheritance:
:imported-members:
.. :exclude-members:
.. :exclude-members: +
pp_helper module
----------------

.. automodule:: pathos.helpers.pp_helper
:members:
:undoc-members:
:private-members:
:special-members:
:show-inheritance:
:imported-members:
.. :exclude-members:
.. :exclude-members: +
4 changes: 1 addition & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ pathos package documentation
============================

.. automodule:: pathos
:members:
:undoc-members:
:show-inheritance:
.. :exclude-members: +
.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit 993bf7f

Please sign in to comment.