summaryrefslogtreecommitdiff
path: root/api-docs/source/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'api-docs/source/conf.py')
-rw-r--r--api-docs/source/conf.py45
1 files changed, 7 insertions, 38 deletions
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'