# -*- coding: utf-8 -*- """ Sphinx Auto-API Top-level Extension. This extension allows you to automagically generate API documentation from your project. """ import os import shutil import sphinx from sphinx.util.console import darkgreen, bold from sphinx.addnodes import toctree from sphinx.errors import ExtensionError from docutils.parsers.rst import directives from .backends import default_file_mapping, default_ignore_patterns, default_backend_mapping from .directives import AutoapiSummary, NestedParse from .settings import API_ROOT from .toctree import add_domain_to_toctree default_options = ['members', 'undoc-members', 'private-members', 'special-members'] def run_autoapi(app): """ Load AutoAPI data from the filesystem. """ if not app.config.autoapi_dirs: raise ExtensionError('You must configure an autoapi_dirs setting') # Make sure the paths are full normalized_dirs = [] autoapi_dirs = app.config.autoapi_dirs if isinstance(autoapi_dirs, str): autoapi_dirs = [autoapi_dirs] for path in autoapi_dirs: if os.path.isabs(path): normalized_dirs.append(path) else: normalized_dirs.append( os.path.normpath(os.path.join(app.confdir, path)) ) for _dir in normalized_dirs: if not os.path.exists(_dir): raise ExtensionError( 'AutoAPI Directory `{dir}` not found. ' 'Please check your `autoapi_dirs` setting.'.format( dir=_dir ) ) normalized_root = os.path.normpath(os.path.join(app.confdir, app.config.autoapi_root)) url_root = os.path.join('/', app.config.autoapi_root) sphinx_mapper = default_backend_mapping[app.config.autoapi_type] sphinx_mapper_obj = sphinx_mapper(app, template_dir=app.config.autoapi_template_dir, url_root=url_root) app.env.autoapi_mapper = sphinx_mapper_obj if app.config.autoapi_file_patterns: file_patterns = app.config.autoapi_file_patterns else: file_patterns = default_file_mapping.get(app.config.autoapi_type, []) if app.config.autoapi_ignore: ignore_patterns = app.config.autoapi_ignore else: ignore_patterns = default_ignore_patterns.get(app.config.autoapi_type, []) if '.rst' in app.config.source_suffix: out_suffix = '.rst' elif '.txt' in app.config.source_suffix: out_suffix = '.txt' else: # Fallback to first suffix listed out_suffix = app.config.source_suffix[0] # Actual meat of the run. app.info(bold('[AutoAPI] ') + darkgreen('Loading Data')) sphinx_mapper_obj.load( patterns=file_patterns, dirs=normalized_dirs, ignore=ignore_patterns, ) app.info(bold('[AutoAPI] ') + darkgreen('Mapping Data')) sphinx_mapper_obj.map(options=app.config.autoapi_options) app.info(bold('[AutoAPI] ') + darkgreen('Rendering Data')) sphinx_mapper_obj.output_rst( root=normalized_root, source_suffix=out_suffix, ) def build_finished(app, exception): if not app.config.autoapi_keep_files: normalized_root = os.path.normpath(os.path.join(app.confdir, app.config.autoapi_root)) if app.verbosity > 1: app.info(bold('[AutoAPI] ') + darkgreen('Cleaning generated .rst files')) shutil.rmtree(normalized_root) sphinx_mapper = default_backend_mapping[app.config.autoapi_type] if hasattr(sphinx_mapper, 'build_finished'): sphinx_mapper.build_finished(app, exception) def doctree_read(app, doctree): """ Inject AutoAPI into the TOC Tree dynamically. """ if app.env.docname == 'index': all_docs = set() insert = True nodes = doctree.traverse(toctree) toc_entry = '%s/index' % app.config.autoapi_root if not nodes: return # Capture all existing toctree entries root = nodes[0] for node in nodes: for entry in node['entries']: all_docs.add(entry[1]) # Don't insert autoapi it's already present for doc in all_docs: if doc.find(app.config.autoapi_root) != -1: insert = False if insert and app.config.autoapi_add_toctree_entry: if app.config.autoapi_add_api_root_toctree: # Insert full API TOC in root TOC for path in app.env.autoapi_toc_entries: nodes[-1]['entries'].append( (None, path[1:]) ) nodes[-1]['includefiles'].append(path) else: # Insert AutoAPI index nodes[-1]['entries'].append( (None, u'%s/index' % app.config.autoapi_root) ) nodes[-1]['includefiles'].append(u'%s/index' % app.config.autoapi_root) app.info(bold('[AutoAPI] ') + darkgreen('Adding AutoAPI TOCTree [%s] to index.rst' % toc_entry) ) def clear_env(app, env): """Clears the environment of the unpicklable objects that we left behind.""" env.autoapi_mapper = None def setup(app): app.connect('builder-inited', run_autoapi) app.connect('doctree-read', doctree_read) app.connect('doctree-resolved', add_domain_to_toctree) app.connect('build-finished', build_finished) app.connect('env-updated', clear_env) app.add_config_value('autoapi_type', 'python', 'html') app.add_config_value('autoapi_root', API_ROOT, 'html') app.add_config_value('autoapi_ignore', [], 'html') app.add_config_value('autoapi_options', default_options, 'html') app.add_config_value('autoapi_file_patterns', None, 'html') app.add_config_value('autoapi_dirs', [], 'html') app.add_config_value('autoapi_keep_files', False, 'html') app.add_config_value('autoapi_add_toctree_entry', True, 'html') app.add_config_value('autoapi_add_api_root_toctree', False, 'html') app.add_config_value('autoapi_template_dir', [], 'html') app.add_stylesheet('autoapi.css') directives.register_directive('autoapi-nested-parse', NestedParse) directives.register_directive('autoapisummary', AutoapiSummary)