AutomodapiOptions
=================

.. currentmodule:: plasmapy_sphinx.autodoc.automodapi

.. autoclass:: AutomodapiOptions
   :show-inheritance:

   
     
   

   
   

   .. rubric:: Attributes Summary

   .. autosummary::
   
      ~AutomodapiOptions.app
      ~AutomodapiOptions.custom_grouping_info
      ~AutomodapiOptions.default_grouping_info
      ~AutomodapiOptions.docname
      ~AutomodapiOptions.grouping_info
      ~AutomodapiOptions.groupings
      ~AutomodapiOptions.logger
      ~AutomodapiOptions.mod_objs
      ~AutomodapiOptions.mod_objs_option_filtered
      ~AutomodapiOptions.modname
      ~AutomodapiOptions.option_spec
      ~AutomodapiOptions.options
      ~AutomodapiOptions.options_for_automodsumm
      ~AutomodapiOptions.pkg_or_module
      ~AutomodapiOptions.warn

   
   

   
   

   .. rubric:: Methods Summary

   .. autosummary::
   
      ~AutomodapiOptions.condition_group_options
      ~AutomodapiOptions.condition_heading_chars_option
      ~AutomodapiOptions.condition_include_heading_option
      ~AutomodapiOptions.condition_inheritance_diagram_option
      ~AutomodapiOptions.condition_options
      ~AutomodapiOptions.condition_toctree_option
      ~AutomodapiOptions.generate_obj_list

   
   

   
   

   .. rubric:: Attributes Documentation

   
   .. autoattribute:: app
   .. autoattribute:: custom_grouping_info
   .. autoattribute:: default_grouping_info
   .. autoattribute:: docname
   .. autoattribute:: grouping_info
   .. autoattribute:: groupings
   .. autoattribute:: logger
   .. autoattribute:: mod_objs
   .. autoattribute:: mod_objs_option_filtered
   .. autoattribute:: modname
   .. autoattribute:: option_spec
   .. autoattribute:: options
   .. autoattribute:: options_for_automodsumm
   .. autoattribute:: pkg_or_module
   .. autoattribute:: warn

   
   

   
   

   .. rubric:: Methods Documentation

   
   .. automethod:: condition_group_options
   .. automethod:: condition_heading_chars_option
   .. automethod:: condition_include_heading_option
   .. automethod:: condition_inheritance_diagram_option
   .. automethod:: condition_options
   .. automethod:: condition_toctree_option
   .. automethod:: generate_obj_list