2015-04-22 22:46:40 +00:00
|
|
|
AutoAPI Configuration
|
2015-06-22 17:51:49 +00:00
|
|
|
=====================
|
2015-04-22 22:46:40 +00:00
|
|
|
|
2015-06-22 17:51:49 +00:00
|
|
|
Configuration Options
|
|
|
|
|
---------------------
|
2015-06-22 17:50:30 +00:00
|
|
|
|
2015-09-23 23:01:34 +00:00
|
|
|
.. confval:: autoapi_dirs
|
2015-04-22 22:46:40 +00:00
|
|
|
|
|
|
|
|
**Required**
|
|
|
|
|
|
2015-09-23 23:01:34 +00:00
|
|
|
Paths (relative or absolute) to the source code that you wish to generate your API documentation from.
|
2015-04-22 22:46:40 +00:00
|
|
|
|
|
|
|
|
.. confval:: autoapi_type
|
|
|
|
|
|
2015-06-22 17:50:30 +00:00
|
|
|
Default: ``python``
|
2015-04-22 22:46:40 +00:00
|
|
|
|
|
|
|
|
Set the type of files you are documenting
|
|
|
|
|
|
2015-06-06 20:44:01 +00:00
|
|
|
.. confval:: autoapi_template_dir
|
|
|
|
|
|
|
|
|
|
Default: ``''``
|
|
|
|
|
|
|
|
|
|
A directory that has user-defined templates to override our default templates.
|
|
|
|
|
|
2015-06-22 17:50:30 +00:00
|
|
|
You can see the existing files in the `autoapi/templates`_ directory.
|
2015-04-22 22:46:40 +00:00
|
|
|
|
2015-07-07 23:40:24 +00:00
|
|
|
.. confval:: autoapi_file_patterns
|
|
|
|
|
|
|
|
|
|
Default: ``Varies by Language``
|
|
|
|
|
|
|
|
|
|
A list containing the file patterns to look for when generating documentation. Python for example is ``['*.py']``.
|
|
|
|
|
|
2015-06-22 17:51:49 +00:00
|
|
|
Customization Options
|
|
|
|
|
---------------------
|
2015-04-22 22:46:40 +00:00
|
|
|
|
2015-06-10 20:58:52 +00:00
|
|
|
.. confval:: autoapi_options
|
|
|
|
|
|
|
|
|
|
Default: ``['members', 'undoc-members', 'private-members', 'special-members']``
|
|
|
|
|
|
|
|
|
|
Options for display of the documentation.
|
|
|
|
|
|
|
|
|
|
:param members: Display children of an object
|
|
|
|
|
:param undoc-members: Display undocumented object
|
|
|
|
|
:param private-members: Display private objects (_foo in Python)
|
|
|
|
|
:param special-members: Display special objects (__foo__ in Python)
|
|
|
|
|
|
2015-06-22 17:50:30 +00:00
|
|
|
|
|
|
|
|
.. confval:: autoapi_ignore
|
|
|
|
|
|
|
|
|
|
Default: ``[]``
|
|
|
|
|
|
|
|
|
|
A list of patterns to ignore when finding files
|
|
|
|
|
|
|
|
|
|
.. confval:: autoapi_root
|
|
|
|
|
|
|
|
|
|
Default: ``autoapi``
|
|
|
|
|
|
2015-10-28 18:04:23 +00:00
|
|
|
Relative path to output the AutoAPI files into
|
2015-06-22 17:50:30 +00:00
|
|
|
|
2015-06-22 17:51:49 +00:00
|
|
|
Debugging Options
|
|
|
|
|
-----------------
|
2015-06-22 17:50:30 +00:00
|
|
|
|
|
|
|
|
.. confval:: autoapi_keep_files
|
|
|
|
|
|
|
|
|
|
Default: ``False``
|
|
|
|
|
|
|
|
|
|
Keep the AutoAPI generated files on the filesystem after the run.
|
|
|
|
|
Useful for debugging.
|
|
|
|
|
|
|
|
|
|
.. _autoapi/templates:: https://github.com/rtfd/sphinx-autoapi/tree/master/autoapi/templates
|
