Sphinx AutoAPI Documentation

Transcription

1 Sphinx AutoAPI Documentation Release Read the Docs, Inc Nov 13, 2017

2

3 Main 1 Contents AutoAPI Configuration Templates Sphinx AutoAPI Reference Design Sphinx AutoAPI Index Basic Workflow 19 3 Install 21 4 Setup NET GO Javascript Customize 25 6 Design 27 7 Currently Implemented 29 8 Adding a new language 31 Python Module Index 33 i

4 ii

5 Warning: This is a pre-release version. Some or all features might not work yet. Sphinx AutoAPI aims to provide autodoc or javadoc style documentation for Sphinx. The aim is to support all programming languages, be easy to use, and not require much configuration. AutoAPI is a parse-only solution for both static and dynamic languages. This is in contrast to the traditional Sphinx autodoc, which is Python-only and uses code imports. Full documentation can be found on Read the Docs. Main 1

6 2 Main

7 CHAPTER 1 Contents 1.1 AutoAPI Configuration Configuration Options autoapi_dirs Required Paths (relative or absolute) to the source code that you wish to generate your API documentation from. autoapi_type Default: python Set the type of files you are documenting autoapi_template_dir Default: '' A directory that has user-defined templates to override our default templates. You can see the existing files in the autoapi/templates _ directory. autoapi_file_patterns Default: Varies by Language A list containing the file patterns to look for when generating documentation. Python for example is ['*.py'] Customization Options 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 3

8 autoapi_ignore Default: [] Param private-members Display private objects (_foo in Python) Param special-members Display special objects ( foo in Python) A list of patterns to ignore when finding files autoapi_root Default: autoapi Relative path to output the AutoAPI files into autoapi_include_summaries Default: False Whether include autosummary directives in generated module documentation Debugging Options autoapi_keep_files Default: False Keep the AutoAPI generated files on the filesystem after the run. Useful for debugging. 1.2 Templates A lot of the power from AutoAPI comes from templates. We are basically building a mapping from Code to Docs, and templates let you highly customize the display of said docs Structure Every type of data structure gets its own template. It uses the form language/type.rst to find the template to render. The full search path is: language/type.rst language/unknown.rst base/unknown.rst So for a.net Class, this would resolve to: dotnet/class.rst dotnet/unknown.rst base/unknown.rst We provide base/member.rst as an incredibly basic output of every object:.. {language}:{type}:: {name} 4 Chapter 1. Contents

9 1.2.2 Context Every template will be given a set context. It will contain: obj: A Python object derived from This object has a number of standard attributes you can reliably access: id - A unique identifier type - The objects type, lowercase name - A user displayable name item_map - A dict with keys containing the types this object has as children, and values of those objects. 1.3 Sphinx AutoAPI Reference Design This document talks about the design of a.net Sphinx integration. This will include a mechanism for generating Javadoc style API references automatically. We will describe decisions that lead to specific implementation details Goals The main goal of this project is to be able to generate a MSDN or Javadoc style API reference from a.net project in Sphinx. Primary Goals Build MSDN/Javadoc style HTML output for arbitrary.net code. Have specific pages for each Package, Class, and all class-level structures. /api/system/ /api/system/string/ /api/system/string/constructors/ Secondary Goals Allow for definition of.net classes inside of normal Sphinx prose docs (classic Sphinx style definition). Allow generation of Javadoc style docs from other languages. Requirements Introduction We are working with Sphinx, which has an existing way of doing this. Generally, you define a Domain which describes the various language structure, a Class or Method, for example. Then the user will write RST that uses these definitions, and Sphinx will create output from that markup... py:function:: spam(eggs) Spam the foo Sphinx AutoAPI Reference Design 5

10 The author of the doucmentation will have now told Sphinx that the spam function exists in the Python project that is being documented. Autogenerated Output Sphinx then built a series of tools to make the generation of this markup easier and more automatic: Autodoc Autosummary Autodoc is a Python-only solution that imports the author s code into memory, and then allows the author to more automatically document full objects. For example, you can document a whole class on a page... autoclass:: Noodle This will generate output that looks like: class Noodle Noodle s docstring. There are also options for it to include a full listing of the classes attributes, methods, and other things, automatically. Warning: Remember, this depends on Noodle being importable by the Python interpreter running Sphinx Proposed Architecture The proposed architecture for this project is as follows: A program that will generate a YAML (or JSON) file from a.net project, representing it s full API information. Read the YAML and generate an appropriate tree structure that will the outputted HTML will look like (YAML- Tree) If time allows, we will allow a merging of these objects with multiple YAML files to allow for prose content to be injected into the output Take the YAML structure and generate in-memory rst that corresponds to the Sphinx dotnet Domain objects dotnet Domain will output HTML based on the doctree generated from the in-memory RST In diagram form: Code -> YAML -> YAMLTree -> RST (Dotnet Domain) -> Sphinx -> HTML YAMLTree One of the main problems is how to actually structure the outputted HTML pages. The YAML file will likely be ordered, but we need to have a place to define the page structure in the HTML. This can be done before or after the loading of the content into RST. We decided to do it before loading into RST because that matches standard Sphinx convention. Generally the markup being fed in as RST is considered to be in a file that maps to it s output loation. If we tried to maniuplate this structure after loading into the Domain, that could lead to unexpected consequences like wrong indexes and missing references. 6 Chapter 1. Contents

11 File Structure vs. Hierarchy Specific ID s should have one specific detail representation. This means that every YAML docid object should only have one place that it is rendered with a.. dn:<method> canonical identifier. All other places it is referenced should be in either: A reference A toctree (listing) Sphinx Implementation The user will run a normal make html as part of the experience. The generation and loading will be done as an extension that can be configured. There will be Sphinx configuration for how things get built: autoapi_root = 'api' # Where HTML is generated autoapi_dirs = ['yaml'] # Directory of YAML sources We will then loop over all YAML files in the autoapi_dir and parse them. autoapi_root inside the documentation. They will then be output into Examples A nice example of Sphinx Python output similar to what we want: Src: An example domain for Spec: Other Ideas Warning: Things in this section might not get implemented. The.Net domain will not be able to depend on importing code from the users code base. We might be able to implement similar authoring tools with the YAML file. We might be able to output the YAML subtree of an object with autodoc style tools:.. autodnclass:: System.String :members: 1.4 Sphinx AutoAPI Index This page is the top-level of your generated API documentation. Below is a list of all items that are documented here Sphinx AutoAPI Index 7

12 1.4.1 settings Basic settings for AutoAPI projects. You shouldn t need to touch this directives AutoAPI directives Module Contents directives.escape(text) class directives.autoapisummary A version of autosummary that uses static analysis. warn(msg) Add a warning message. Parameters msg (str) The warning message to add. _get_names() Get the names of the objects to include in the table. run() _get_row(obj) Returns The names of the objects to include. Return type generator(str) _get_table(objects) class directives.nestedparse Nested parsing to remove the first heading of included rst This is used to handle the case where we like to remove user supplied headings from module docstrings. This is required to reduce the number of duplicate headings on sections. run() toctree A small Sphinx extension that adds Domain objects (eg. Python Classes & Methods) to the TOC Tree. It dynamically adds them to the already rendered app.env.tocs dict on the Sphinx environment. Traditionally this only contains Section s, we then nest our Domain references inside the already existing Sections. Module Contents toctree._build_toc_node(docname, anchor= anchor, text= test text, bullet=false) Create the node structure that Sphinx expects for TOC Tree entries. The bullet argument wraps it in a nodes.bullet_list, which is how you nest TOC Tree entries. 8 Chapter 1. Contents

13 toctree._traverse_parent(node, objtypes) Traverse up the node s parents until you hit the objtypes referenced. Can either be a single type, or a tuple of types. toctree._find_toc_node(toc, ref_id, objtype) Find the actual TOC node for a ref_id. Depends on the object type: * Section - First section (refuri) or 2nd+ level section (anchorname) * Desc - Just use the anchor name toctree._get_toc_reference(app, node, toc, docname) Logic that understands maps a specific node to it s part of the toctree. It takes a specific incoming node, and returns the actual TOC Tree node that is said reference. toctree.add_domain_to_toctree(app, doctree, docname) Add domain objects to the toctree dynamically. This should be attached to the doctree-resolved event. This works by: Finding each domain node (addnodes.desc) Figuring out it s parent that will be in the toctree (nodes.section, or a previously added addnodes.desc) Finding that parent in the TOC Tree based on it s ID Taking that element in the TOC Tree, and finding it s parent that is a TOC Listing (nodes.bullet_list) Adding the new TOC element for our specific node as a child of that nodes.bullet_list This checks that bullet_list s last child, and checks that it is also a nodes.bullet_list, effectively nesting it under that element extension Sphinx Auto-API Top-level Extension. This extension allows you to automagically generate API documentation from your project. Module Contents extension.run_autoapi(app) Load AutoAPI data from the filesystem. extension.build_finished(app, exception) extension.doctree_read(app, doctree) Inject AutoAPI into the TOC Tree dynamically. extension.clear_env(app, env) Clears the environment of the unpicklable objects that we left behind. extension.setup(app) 1.4. Sphinx AutoAPI Index 9

14 1.4.5 utils Module Contents utils.slugify(value) Converts to lowercase, removes non-word characters (alphanumerics and underscores) and converts spaces to hyphens. Also strips leading and trailing whitespace init Sphinx AutoAPI mappers Submodules mappers.base Module Contents class mappers.base.pythonmapperbase(obj, options=none, jinja_env=none, url_root=none) Base object for JSON -> Python object mapping. Subclasses of this object will handle their language specific JSON input, and map that onto this standard Python object. Subclasses may also include language-specific attributes on this object. Arguments: Parameters Required attributes: Variables Optional attributes: Variables render(**kwargs) obj JSON object representing this object jinja_env A template environment for rendering this object url_root API URL root prefix id (str) A globally unique indentifier for this object. Generally a fully qualified name, including namespace. name (str) A short display friendly name for this object. docstring (str) The documentation for this object imports (list) Imports in this object children (list) Children of this object parameters (list) Parameters to this object methods (list) Methods on this object 10 Chapter 1. Contents

15 rendered() Shortcut to render an object in templates. get_absolute_path() get_context_data() short_name() Shorten name property pathname() Sluggified path for filenames Slugs to a filename using the follow steps Decode unicode to approximate ascii Remove existing hypens Substitute hyphens for non-word characters Break up the string as paths include_dir(root) Return directory of file include_path() Return absolute path without regarding OS path separator This is used in toctree directives, as Sphinx always expects Unix path separators ref_type() ref_directive() namespace() signature() class mappers.base.sphinxmapperbase(app, template_dir=none, url_root=none) Base class for mapping PythonMapperBase objects to Sphinx. Parameters app Sphinx application instance load(patterns, dirs, ignore=none) Load objects from the filesystem into the paths dictionary. find_files(patterns, dirs, ignore) read_file(path, **kwargs) Read file input into memory Parameters path Path of file to read add_object(obj) Add object to local and app environment storage Parameters obj Instance of a AutoAPI object map(options=none) Trigger find of serialized sources and build objects create_class(data, options=none, **kwargs) Create class object. Parameters data Instance of a AutoAPI object output_rst(root, source_suffix) 1.4. Sphinx AutoAPI Index 11

16 _output_top_rst(root) mappers.dotnet Module Contents class mappers.dotnet.dotnetsphinxmapper Auto API domain handler for.net Searches for YAML files, and soon to be JSON files as well, for auto API sources. If no pattern configuration was explicitly specified, then default to looking up a docfx.json file. Parameters app Sphinx application passed in as part of the extension load(patterns, dirs, ignore=none, **kwargs) Load objects from the filesystem into the paths dictionary. If the setting autoapi_patterns was not specified, look for a docfx.json file by default. A docfx.json should be treated as the canonical source before the default patterns. Fallback to default pattern matches if no docfx.json files are found. read_file(path, **kwargs) Read file input into memory, returning deserialized objects Parameters path Path of file to read map(options=none) Trigger find of serialized sources and build objects create_class(data, options=none, path=none, **kwargs) Return instance of class based on Roslyn type property Data keys handled here: type Set the object class items Recurse into create_class() to create child object instances Parameters data dictionary data from Roslyn output artifact add_object(obj) Add object to local and app environment storage Parameters obj Instance of a.net object organize_objects() Organize objects and namespaces output_rst(root, source_suffix) build_finished(exception) class mappers.dotnet.dotnetpythonmapper(obj, **kwargs) Base.NET object representation Parameters references (list of dict objects) object reference list from docfx pathname() Sluggified path for filenames Slugs to a filename using the follow steps Decode unicode to approximate ascii 12 Chapter 1. Contents

17 Remove existing hypens Substitute hyphens for non-word characters Break up the string as paths short_name() Shorten name property edit_link() source() path() namespace() top_namespace() ref_type() ref_directive() ref_name() Return object name suitable for use in references Escapes several known strings that cause problems, including the following reference syntax: :dotnet:cls:`foo.bar<t>` As the <T> notation is also special syntax in references, indicating the reference to Foo.Bar should be named T. See: ref_short_name() Same as above, return the truncated name instead transform_doc_comments() Parse XML content for references and other syntax. This avoids an LXML dependency, we only need to parse out a small subset of elements here. Iterate over string to reduce regex pattern complexity and make substitutions easier See also: Doc comment reference < Reference XML documentation comment syntax on resolve_spec_identifier(obj_name) Find reference name based on spec identifier Spec identifiers are used in parameter and return type definitions, but should be a user-friendly version instead. Use docfx references lookup mapping for resolution. If the spec identifier reference has a spec.csharp key, this implies a compound reference that should be linked in a special way. Resolve to a nested reference, with the corrected nodes. Note: fields. This uses a special format that is interpreted by the domain for parameter type and return type Parameters obj_name spec identifier to resolve to a correct reference 1.4. Sphinx AutoAPI Index 13

18 Returns resolved string with one or more references Return type str class mappers.dotnet.dotnetnamespace class mappers.dotnet.dotnetmethod class mappers.dotnet.dotnetoperator class mappers.dotnet.dotnetproperty class mappers.dotnet.dotnetenum class mappers.dotnet.dotnetstruct class mappers.dotnet.dotnetconstructor class mappers.dotnet.dotnetinterface class mappers.dotnet.dotnetdelegate class mappers.dotnet.dotnetclass class mappers.dotnet.dotnetfield class mappers.dotnet.dotnetevent mappers.go Module Contents class mappers.go.gosphinxmapper Auto API domain handler for Go Parses directly from Go files. Parameters app Sphinx application passed in as part of the extension load(patterns, dirs, ignore=none) Load objects from the filesystem into the paths dictionary. read_file(path, **kwargs) Read file input into memory, returning deserialized objects Parameters path Path of file to read create_class(data, options=none, **kwargs) Return instance of class based on Go data Data keys handled here: _type Set the object class consts, types, vars, funcs Recurse into create_class() to create child object instances Parameters data dictionary data from godocjson output class mappers.go.gopythonmapper(obj, **kwargs) short_name() Shorten name property 14 Chapter 1. Contents

19 namespace() ref_type() ref_directive() methods() class mappers.go.govariable class mappers.go.gomethod class mappers.go.goconstant class mappers.go.gofunction class mappers.go.gopackage class mappers.go.gotype mappers.javascript Module Contents class mappers.javascript.javascriptsphinxmapper Auto API domain handler for Javascript Parses directly from Javascript files. Parameters app Sphinx application passed in as part of the extension read_file(path, **kwargs) Read file input into memory, returning deserialized objects Parameters path Path of file to read map(options=none) Trigger find of serialized sources and build objects create_class(data, options=none, **kwargs) Return instance of class based on Javascript data Data keys handled here: type Set the object class consts, types, vars, funcs Recurse into create_class() to create child object instances Parameters data dictionary data from godocjson output class mappers.javascript.javascriptpythonmapper(obj, **kwargs) class mappers.javascript.javascriptclass class mappers.javascript.javascriptfunction class mappers.javascript.javascriptdata class mappers.javascript.javascriptmember class mappers.javascript.javascriptattribute 1.4. Sphinx AutoAPI Index 15

20 mappers.python Module Contents class mappers.python.pythonsphinxmapper Auto API domain handler for Python Parses directly from Python files. Parameters app Sphinx application passed in as part of the extension load(patterns, dirs, ignore=none) Load objects from the filesystem into the paths dictionary Also include an attribute on the object, relative_path which is the shortened, relative path the package/module read_file(path, **kwargs) Read file input into memory, returning deserialized objects Parameters path Path of file to read map(options=none) create_class(data, options=none, **kwargs) Create a class from the passed in data Parameters data dictionary data of pydocstyle output _output_top_rst(root) class mappers.python.pythonpythonmapper(obj, **kwargs) args() args(value) is_undoc_member() is_private_member() is_special_member() display() _get_full_name() Recursively build the full name of the object from pydocstyle Uses an additional attribute added to the object, relative_path. This is the shortened path of the object name, if the object is a package or module. Parameters obj pydocstyle object, as returned from Parser() Returns Dotted name of object Return type str _get_arguments() Get arguments from a pydocstyle object Parameters obj pydocstyle object, as returned from Parser() Returns list of argument or argument and value pairs Return type list 16 Chapter 1. Contents

21 summary() class mappers.python.pythonfunction class mappers.python.pythonmethod class mappers.python.toplevelpythonpythonmapper(obj, **kwargs) _children_of_type(type_) functions() methods() classes() class mappers.python.pythonmodule class mappers.python.pythonpackage class mappers.python.pythonclass args() class mappers.python.parserextra Extend Parser object to provide customized return parse_object_identifier() Parse object identifier parse_string() Clean up STRING nodes parse_number() Parse a NUMBER node to either a float or int parse_iterable() Recursively parse an iterable object This will return a local representation of the parsed data, except for NAME nodes. This does not currently attempt to perform lookup on the object names defined in an iterable. This is mostly a naive implementation and won t handle complex structures. This is only currently meant to parse simple iterables, such as all and class parent classes on class definition. parse_docstring() Clean up object docstring parse_all() Parse all assignment This differs from the default all assignment processing by: Accepting multiple all assignments Doesn t throw exceptions on edge cases Parses NAME nodes (but throws them out for now 1.4. Sphinx AutoAPI Index 17

22 18 Chapter 1. Contents

23 CHAPTER 2 Basic Workflow Sphinx AutoAPI has the following structure: Configure directory to look for source files Serialize those source files, using language-specific tooling Map the serialized data into standard AutoAPI Python objects Generate RST through Jinja2 templates from those Python objects This basic framework should be easy to implement in your language of choice. All you need to do is be able to generate a JSON structure that includes your API and docs for those classes, functions, etc. 19

24 20 Chapter 2. Basic Workflow

25 CHAPTER 3 Install First you need to install autoapi: pip install sphinx-autoapi Then add it to your Sphinx project s conf.py: extensions = ['autoapi.extension'] # Document Python Code autoapi_type = 'python' autoapi_dirs = ['path/to/python/files', 'path/to/more/python/files'] # Or, Document Go Code autoapi_type = 'go' autoapi_dirs = 'path/to/go/files' AutoAPI will automatically add itself to the last TOCTree in your top-level index.rst. This is needed because we will be outputting rst files into the autoapi directory. This adds it into the global TOCTree for your project, so that it appears in the menus. We hope to be able to dynamically add items into the TOCTree, and remove this step. However, it is currently required. See all available configuration options in AutoAPI Configuration. 21

26 22 Chapter 3. Install

27 CHAPTER 4 Setup 4.1.NET The.NET mapping utilizes the tool docfx. To install docfx, first you ll need to install a.net runtime on your system. The docfx tool can be installed with: dnu commands install docfx By default, docfx will output metadata files into the _api path. You can configure which path to output files into by setting the path in your docfx configuration file in your project s repository. For example: { }... "metadata": [{... "dest": "docs/_api",... }] Note: The dest configuration option is required to output to the docs/ path, where autoapi knows to search for these files. With a working docfx toolchain, you can now add the configuration options to enable the.net autoapi mapper. In your conf.py: extensions = ['autoapi.extension'] autoapi_type = 'dotnet' autoapi_dirs = ['..'] 23

28 This configuration assumes your conf.py is in a docs/ path, and will use your parent path (.. ) to search for files to pass to docfx. Unless you specify a custom pattern, using the autoapi_patterns option, sphinx-autoapi will assume a list of file names to search. First, a docfx.json file will be searched for. If this file exists, it will be used, regardless of whether you have other file patterns listed. Otherwise, any file matching ['project.json', 'csproj', 'vsproj'] will be searched for. 4.2 GO Install go domain extension for sphinx. Install the go environment (from Install a git client for your environment (e.g. from Install our godocjson tool (preprocess godoc output to JSON, in a way similar to jsdoc -X). Add go domain in your conf.py. Before running building your doc, make sure the godocjson executable is in your path. 4.3 Javascript Requires jsdoc, which in turn requires nodejs to be installed. Install nodejs on your platform. Install jsdoc using npm. Before building your doc, make sure the jsdoc executable is in your path. 24 Chapter 4. Setup

29 CHAPTER 5 Customize All of the pages that AutoAPI generates are templated with Jinja2 templates. You can fully customize how pages are displayed on a per-object basis. Read more about it in Templates. 25

30 26 Chapter 5. Customize

31 CHAPTER 6 Design Read more about the deisgn in our Sphinx AutoAPI Reference Design. 27

32 28 Chapter 6. Design

33 CHAPTER 7 Currently Implemented Python (2 only Epydoc doesn t support Python 3).NET Go Javascript 29

34 30 Chapter 7. Currently Implemented

35 CHAPTER 8 Adding a new language Adding a new language should only take a couple of hours, assuming your language has a tool to generate JSON from API documentation. The steps to follow: Add a new Mapper file in mappers/. It s probably easiest to copy an existing one, like the Javascript or Python mappers. Implement the create_class() and read_file() methods on the SphinxMapperBase. Implement all appropriate object types on the PythonMapperBase Add a test in the tests/test_integration.py, along with an example project for the testing. Include it in the class mapping in mappers/base.py and extension.py 31

36 32 Chapter 8. Adding a new language

37 Python Module Index init, 10 d directives, 8 e extension, 9 m mappers, 10 mappers.base, 10 mappers.dotnet, 12 mappers.go, 14 mappers.javascript, 15 mappers.python, 16 s settings, 8 t toctree, 8 u utils, 10 33

38 34 Python Module Index

39 Index Symbols init (module), 10 _build_toc_node() (in module toctree), 8 _children_of_type() (mappers.python.toplevelpythonpythonmapper method), 17 _find_toc_node() (in module toctree), 9 _get_arguments() (mappers.python.pythonpythonmapper method), 16 _get_full_name() (mappers.python.pythonpythonmapper method), 16 _get_names() (directives.autoapisummary method), 8 _get_row() (directives.autoapisummary method), 8 _get_table() (directives.autoapisummary method), 8 _get_toc_reference() (in module toctree), 9 _output_top_rst() (mappers.base.sphinxmapperbase method), 11 _output_top_rst() (mappers.python.pythonsphinxmapper method), 16 _traverse_parent() (in module toctree), 8 A add_domain_to_toctree() (in module toctree), 9 add_object() (mappers.base.sphinxmapperbase method), 11 add_object() (mappers.dotnet.dotnetsphinxmapper method), 12 args() (mappers.python.pythonclass method), 17 args() (mappers.python.pythonpythonmapper method), 16 autoapi_dirs configuration value, 3 autoapi_file_patterns configuration value, 3 autoapi_ignore configuration value, 4 autoapi_include_summaries configuration value, 4 autoapi_keep_files configuration value, 4 autoapi_options configuration value, 3 autoapi_root configuration value, 4 autoapi_template_dir configuration value, 3 autoapi_type configuration value, 3 AutoapiSummary (class in directives), 8 B build_finished() (in module extension), 9 build_finished() (mappers.dotnet.dotnetsphinxmapper method), 12 C classes() (mappers.python.toplevelpythonpythonmapper method), 17 clear_env() (in module extension), 9 configuration value autoapi_dirs, 3 autoapi_file_patterns, 3 autoapi_ignore, 4 autoapi_include_summaries, 4 autoapi_keep_files, 4 autoapi_options, 3 autoapi_root, 4 autoapi_template_dir, 3 autoapi_type, 3 create_class() (mappers.base.sphinxmapperbase method), 11 create_class() (mappers.dotnet.dotnetsphinxmapper method), 12 create_class() (mappers.go.gosphinxmapper method), 14 create_class() (mappers.javascript.javascriptsphinxmapper method), 15 35

40 create_class() (mappers.python.pythonsphinxmapper method), 16 D directives (module), 8 display() (mappers.python.pythonpythonmapper method), 16 doctree_read() (in module extension), 9 DotNetClass (class in mappers.dotnet), 14 DotNetConstructor (class in mappers.dotnet), 14 DotNetDelegate (class in mappers.dotnet), 14 DotNetEnum (class in mappers.dotnet), 14 DotNetEvent (class in mappers.dotnet), 14 DotNetField (class in mappers.dotnet), 14 DotNetInterface (class in mappers.dotnet), 14 DotNetMethod (class in mappers.dotnet), 14 DotNetNamespace (class in mappers.dotnet), 14 DotNetOperator (class in mappers.dotnet), 14 DotNetProperty (class in mappers.dotnet), 14 DotNetPythonMapper (class in mappers.dotnet), 12 DotNetSphinxMapper (class in mappers.dotnet), 12 DotNetStruct (class in mappers.dotnet), 14 E edit_link() (mappers.dotnet.dotnetpythonmapper method), 13 escape() (in module directives), 8 extension (module), 9 F find_files() (mappers.base.sphinxmapperbase method), 11 functions() (mappers.python.toplevelpythonpythonmapper G method), 17 get_absolute_path() (mappers.base.pythonmapperbase method), 11 get_context_data() (mappers.base.pythonmapperbase method), 11 GoConstant (class in mappers.go), 15 GoFunction (class in mappers.go), 15 GoMethod (class in mappers.go), 15 GoPackage (class in mappers.go), 15 GoPythonMapper (class in mappers.go), 14 GoSphinxMapper (class in mappers.go), 14 GoType (class in mappers.go), 15 GoVariable (class in mappers.go), 15 I include_dir() (mappers.base.pythonmapperbase method), 11 include_path() (mappers.base.pythonmapperbase method), 11 (map- method), is_private_member() pers.python.pythonpythonmapper 16 is_special_member() pers.python.pythonpythonmapper 16 is_undoc_member() pers.python.pythonpythonmapper 16 (map- method), (map- method), J JavaScriptAttribute (class in mappers.javascript), 15 JavaScriptClass (class in mappers.javascript), 15 JavaScriptData (class in mappers.javascript), 15 JavaScriptFunction (class in mappers.javascript), 15 JavaScriptMember (class in mappers.javascript), 15 JavaScriptPythonMapper (class in mappers.javascript), 15 JavaScriptSphinxMapper (class in mappers.javascript), 15 L load() (mappers.base.sphinxmapperbase method), 11 load() (mappers.dotnet.dotnetsphinxmapper method), 12 load() (mappers.go.gosphinxmapper method), 14 load() (mappers.python.pythonsphinxmapper method), 16 M map() (mappers.base.sphinxmapperbase method), 11 map() (mappers.dotnet.dotnetsphinxmapper method), 12 map() (mappers.javascript.javascriptsphinxmapper method), 15 map() (mappers.python.pythonsphinxmapper method), 16 mappers (module), 10 mappers.base (module), 10 mappers.dotnet (module), 12 mappers.go (module), 14 mappers.javascript (module), 15 mappers.python (module), 16 methods() (mappers.go.gopythonmapper method), 15 methods() (mappers.python.toplevelpythonpythonmapper method), 17 N namespace() (mappers.base.pythonmapperbase method), 11 namespace() (mappers.dotnet.dotnetpythonmapper method), 13 namespace() (mappers.go.gopythonmapper method), 14 NestedParse (class in directives), 8 Noodle (built-in class), 6 36 Index

41 O P parse_all() (mappers.python.parserextra method), 17 parse_docstring() (mappers.python.parserextra method), 17 parse_iterable() (mappers.python.parserextra method), 17 parse_number() (mappers.python.parserextra method), 17 parse_object_identifier() (mappers.python.parserextra method), 17 parse_string() (mappers.python.parserextra method), 17 ParserExtra (class in mappers.python), 17 path() (mappers.dotnet.dotnetpythonmapper method), 13 pathname() (mappers.base.pythonmapperbase method), 11 pathname() (mappers.dotnet.dotnetpythonmapper method), 12 PythonClass (class in mappers.python), 17 PythonFunction (class in mappers.python), 17 PythonMapperBase (class in mappers.base), 10 PythonMethod (class in mappers.python), 17 PythonModule (class in mappers.python), 17 PythonPackage (class in mappers.python), 17 PythonPythonMapper (class in mappers.python), 16 PythonSphinxMapper (class in mappers.python), 16 R read_file() (mappers.base.sphinxmapperbase method), 11 read_file() (mappers.dotnet.dotnetsphinxmapper method), 12 read_file() (mappers.go.gosphinxmapper method), 14 read_file() (mappers.javascript.javascriptsphinxmapper method), 15 read_file() (mappers.python.pythonsphinxmapper method), 16 ref_directive() (mappers.base.pythonmapperbase method), 11 ref_directive() (mappers.dotnet.dotnetpythonmapper method), 13 ref_directive() (mappers.go.gopythonmapper method), 15 ref_name() (mappers.dotnet.dotnetpythonmapper method), 13 ref_short_name() (mappers.dotnet.dotnetpythonmapper method), 13 ref_type() (mappers.base.pythonmapperbase method), 11 ref_type() (mappers.dotnet.dotnetpythonmapper method), 13 ref_type() (mappers.go.gopythonmapper method), 15 render() (mappers.base.pythonmapperbase method), 10 rendered() (mappers.base.pythonmapperbase method), 10 (map- method), resolve_spec_identifier() pers.dotnet.dotnetpythonmapper 13 run() (directives.autoapisummary method), 8 run() (directives.nestedparse method), 8 run_autoapi() (in module extension), 9 S settings (module), 8 setup() (in module extension), 9 organize_objects() (mappers.dotnet.dotnetsphinxmapper method), 12 output_rst() (mappers.base.sphinxmapperbase method), 11 output_rst() (mappers.dotnet.dotnetsphinxmapper method), 12 short_name() (mappers.base.pythonmapperbase method), 11 short_name() (mappers.dotnet.dotnetpythonmapper method), 13 short_name() (mappers.go.gopythonmapper method), 14 signature() (mappers.base.pythonmapperbase method), 11 slugify() (in module utils), 10 source() (mappers.dotnet.dotnetpythonmapper method), 13 SphinxMapperBase (class in mappers.base), 11 summary() (mappers.python.pythonpythonmapper method), 16 T toctree (module), 8 top_namespace() (mappers.dotnet.dotnetpythonmapper method), 13 TopLevelPythonPythonMapper (class in mappers.python), 17 (map- method), transform_doc_comments() pers.dotnet.dotnetpythonmapper 13 U utils (module), 10 W warn() (directives.autoapisummary method), 8 Index 37