You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
84 lines
2.5 KiB
Python
84 lines
2.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
Sphinx Auto-API Top-level Extension.
|
|
|
|
This extension allows you to automagically generate API documentation from your project.
|
|
"""
|
|
|
|
import os
|
|
import fnmatch
|
|
import shutil
|
|
|
|
from sphinx.util.console import darkgreen, bold
|
|
|
|
from .mappers import DotNetSphinxMapper, PythonSphinxMapper, GoSphinxMapper, JavaScriptSphinxMapper
|
|
|
|
default_options = ['members', 'undoc-members', 'private-members', 'special-members']
|
|
|
|
|
|
def ignore_file(app, filename):
|
|
for pat in app.config.autoapi_ignore:
|
|
if fnmatch.fnmatch(filename, pat):
|
|
return True
|
|
return False
|
|
|
|
|
|
def run_autoapi(app):
|
|
"""
|
|
Load AutoAPI data from the filesystem.
|
|
"""
|
|
|
|
if not app.config.autoapi_dir:
|
|
print "You must configure an autodapi_dir setting."
|
|
return
|
|
|
|
app.env.autoapi_data = []
|
|
|
|
mapping = {
|
|
'python': PythonSphinxMapper,
|
|
'dotnet': DotNetSphinxMapper,
|
|
'go': GoSphinxMapper,
|
|
'javascript': JavaScriptSphinxMapper,
|
|
}
|
|
|
|
domain = mapping[app.config.autoapi_type]
|
|
domain_obj = domain(app, template_dir=app.config.autoapi_template_dir)
|
|
|
|
app.info(bold('[AutoAPI] ') + darkgreen('Loading Data'))
|
|
domain_obj.load(
|
|
pattern=app.config.autoapi_file_pattern,
|
|
dir=os.path.normpath(app.config.autoapi_dir),
|
|
ignore=app.config.autoapi_ignore,
|
|
)
|
|
|
|
app.info(bold('[AutoAPI] ') + darkgreen('Mapping Data'))
|
|
domain_obj.map(options=app.config.autoapi_options)
|
|
|
|
app.info(bold('[AutoAPI] ') + darkgreen('Rendering Data'))
|
|
domain_obj.output_rst(
|
|
root=app.config.autoapi_root,
|
|
# TODO: Better way to determine suffix?
|
|
source_suffix=app.config.source_suffix[0],
|
|
)
|
|
|
|
|
|
def build_finished(app, exception):
|
|
if not app.config.autoapi_keep_files:
|
|
if app.verbosity > 1:
|
|
app.info(bold('[AutoAPI] ') + darkgreen('Cleaning generated .rst files'))
|
|
shutil.rmtree(app.config.autoapi_root)
|
|
|
|
|
|
def setup(app):
|
|
app.connect('builder-inited', run_autoapi)
|
|
app.connect('build-finished', build_finished)
|
|
app.add_config_value('autoapi_type', 'python', 'html')
|
|
app.add_config_value('autoapi_root', 'autoapi', 'html')
|
|
app.add_config_value('autoapi_ignore', ['*migrations*'], 'html')
|
|
app.add_config_value('autoapi_options', default_options, 'html')
|
|
app.add_config_value('autoapi_file_pattern', '*', 'html')
|
|
app.add_config_value('autoapi_dir', '', 'html')
|
|
app.add_config_value('autoapi_keep_files', False, 'html')
|
|
app.add_config_value('autoapi_template_dir', [], 'html')
|
|
app.add_stylesheet('autoapi.css')
|