2015-04-22 22:46:40 +00:00
|
|
|
AutoAPI Configuration
|
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
|
|
.. confval:: autoapi_dir
|
|
|
|
|
|
|
|
|
|
**Required**
|
|
|
|
|
|
|
|
|
|
Where to find the files to generate the AutoAPI from.
|
|
|
|
|
|
|
|
|
|
.. confval:: autoapi_type
|
|
|
|
|
|
|
|
|
|
Default: ``dotnet``
|
|
|
|
|
|
|
|
|
|
Set the type of files you are documenting
|
|
|
|
|
|
|
|
|
|
.. confval:: autoapi_root
|
|
|
|
|
|
|
|
|
|
Default: ``autoapi``
|
|
|
|
|
|
|
|
|
|
Directory to output the AutoAPI files into
|
|
|
|
|
|
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-04-22 22:46:40 +00:00
|
|
|
.. confval:: autoapi_ignore
|
|
|
|
|
|
|
|
|
|
Default: ``[]``
|
|
|
|
|
|
|
|
|
|
A list of patterns to ignore when finding files
|
|
|
|
|
|
|
|
|
|
.. confval:: autoapi_keep_files
|
|
|
|
|
|
2015-06-10 17:33:18 +00:00
|
|
|
Default: ``True``
|
2015-04-22 22:46:40 +00:00
|
|
|
|
|
|
|
|
Keep the AutoAPI generated files on the filesystem after the run.
|
|
|
|
|
Useful for debugging.
|
|
|
|
|
|
