From a4a5291ff2a7ca343695fc3144a2aafd936b3b45 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Mon, 22 Oct 2018 23:10:26 -0400 Subject: get attributes included in class summary again, remove unneeded extensions, and remove duplicate bn.bn class that snuck in --- api-docs/source/conf.py | 45 +++++++------------------------------------ api-docs/source/global.rst | 0 api-docs/source/old-index.rst | 25 ------------------------ 3 files changed, 7 insertions(+), 63 deletions(-) delete mode 100644 api-docs/source/global.rst delete mode 100644 api-docs/source/old-index.rst (limited to 'api-docs') diff --git a/api-docs/source/conf.py b/api-docs/source/conf.py index 1f5772b5..c0f3dbc7 100644 --- a/api-docs/source/conf.py +++ b/api-docs/source/conf.py @@ -31,7 +31,7 @@ import binaryninja def modulelist(modulename): modules = inspect.getmembers(modulename, inspect.ismodule) - return filter(lambda x: x[0] not in ("abc", "ctypes", "core", "struct", "sys", "_binaryninjacore", "traceback", "code", "enum", "json", "threading", "startup", "associateddatastore"), modules) + return filter(lambda x: x[0] not in ("abc", "binaryninja", "ctypes", "core", "struct", "sys", "_binaryninjacore", "traceback", "code", "enum", "json", "threading", "startup", "associateddatastore"), modules) def classlist(module): @@ -43,6 +43,7 @@ def classlist(module): def setup(app): app.add_stylesheet('css/other.css') + app.is_parallel_allowed('write') def generaterst(): pythonrst = open("index.rst", "w") @@ -102,15 +103,12 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', - 'sphinx.ext.coverage', - 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', - 'sphinx.ext.githubpages', 'breathe' ] autosummary_generate = True -#autodoc_member_order = 'groupwise' +autodoc_member_order = 'groupwise' breathe_projects = { "BinaryNinja": "../../xml/" } breathe_projects_source = { @@ -144,49 +142,20 @@ author = u'Vector 35 LLC' # built documents. # # The short X.Y version. -version = u'1.1' -# The full version, including alpha/beta/rc tags. -release = u'1.1.0' +version = u'.'.join(unicode(binaryninja.core_version).split('.')[0:2]) +release = unicode(binaryninja.core_version) -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# -# today = '' -# -# Else, today_fmt is used as the format for a strftime call. -# -# today_fmt = '%B %d, %Y' +language = 'en' -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path exclude_patterns = [] -# The reST default role (used for this markup: `text`) to use for all -# documents. -# -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# # add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). # -add_module_names = True +add_module_names = False -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# -# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' diff --git a/api-docs/source/global.rst b/api-docs/source/global.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/api-docs/source/old-index.rst b/api-docs/source/old-index.rst deleted file mode 100644 index 355d6901..00000000 --- a/api-docs/source/old-index.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. Binary Ninja API documentation master file, created by - sphinx-quickstart on Tue Jun 28 23:02:45 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -.. include global.rst - -Binary Ninja API Documentation -============================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - Python API -.. C++ API -.. C API - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` -- cgit v1.3.1