summaryrefslogtreecommitdiff
path: root/api-docs/source
diff options
context:
space:
mode:
authorPeter LaFosse <peter@vector35.com>2017-03-05 13:12:01 -0500
committerPeter LaFosse <peter@vector35.com>2017-03-05 13:12:01 -0500
commitcf5997848b8819725315bd2c8dd8a04c70da3b63 (patch)
tree24d9360e3ccfaee361aca4d345072c142c386a41 /api-docs/source
parenta0132eed82d28d4408a2475847e1804a157b3dc1 (diff)
parent27f1271083efb09efc6405f91be893ab38dad9a0 (diff)
Merginging with dev
Diffstat (limited to 'api-docs/source')
-rw-r--r--api-docs/source/conf.py13
-rw-r--r--api-docs/source/old-index.rst (renamed from api-docs/source/index.rst)0
-rw-r--r--api-docs/source/python.rst73
3 files changed, 9 insertions, 77 deletions
diff --git a/api-docs/source/conf.py b/api-docs/source/conf.py
index 379d6d7e..c87cb114 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"), modules)
+ return filter(lambda x: x[0] not in ("abc", "ctypes", "core", "struct", "sys", "_binaryninjacore", "traceback", "code", "enum", "json", "threading", "startup", "associateddatastore"), modules)
def classlist(module):
@@ -43,7 +43,7 @@ def classlist(module):
def generaterst():
- pythonrst = open("python.rst", "w")
+ pythonrst = open("index.rst", "w")
pythonrst.write('''Binary Ninja Python API Documentation
=====================================
@@ -53,7 +53,7 @@ def generaterst():
''')
for modulename, module in modulelist(binaryninja):
- filename = 'binaryninja.{module}.rst'.format(module=modulename)
+ filename = 'binaryninja.{module}-module.rst'.format(module=modulename)
pythonrst.write(' {module} <{filename}>\n'.format(module=modulename, filename=filename))
modulefile = open(filename, "w")
modulefile.write('''{module} module
@@ -69,6 +69,11 @@ def generaterst():
modulefile.write('''\n.. toctree::
:maxdepth: 2\n''')
+
+ modulefile.write('''\n\n.. automodule:: binaryninja.{module}
+ :members:
+ :undoc-members:
+ :show-inheritance:'''.format(module=modulename))
modulefile.close()
pythonrst.write('''.. automodule:: binaryninja
@@ -125,7 +130,7 @@ source_suffix = '.rst'
# source_encoding = 'utf-8-sig'
# The master toctree document.
-master_doc = 'python'
+master_doc = 'index'
# General information about the project.
project = u'Binary Ninja API'
diff --git a/api-docs/source/index.rst b/api-docs/source/old-index.rst
index 355d6901..355d6901 100644
--- a/api-docs/source/index.rst
+++ b/api-docs/source/old-index.rst
diff --git a/api-docs/source/python.rst b/api-docs/source/python.rst
deleted file mode 100644
index 5e299535..00000000
--- a/api-docs/source/python.rst
+++ /dev/null
@@ -1,73 +0,0 @@
-Binary Ninja Python API Documentation
-=====================================
-
-.. currentmodule:: binaryninja
-.. autosummary::
- :toctree:
-
- AnalysisCompletionEvent
- AnalysisProgress
- Architecture
- BasicBlock
- BasicBlockEdge
- BinaryDataNotification
- BinaryDataNotificationCallbacks
- BinaryReader
- BinaryView
- BinaryViewType
- BinaryWriter
- CallingConvention
- CoreFileAccessor
- DataBuffer
- DataVariable
- DisassemblySettings
- DisassemblyTextLine
- Enumeration
- EnumerationMember
- FileAccessor
- Function
- FunctionGraph
- FunctionGraphBlock
- FunctionGraphEdge
- FunctionRecognizer
- IndirectBranchInfo
- InstructionBranch
- InstructionInfo
- InstructionTextToken
- LinearDisassemblyLine
- LinearDisassemblyPosition
- LookupTableEntry
- LowLevelILBasicBlock
- LowLevelILExpr
- LowLevelILFunction
- LowLevelILInstruction
- LowLevelILLabel
- NavigationHandler
- Platform
- PluginCommand
- PluginCommandContext
- ReferenceSource
- RegisterInfo
- RegisterValue
- StackVariable
- StackVariableReference
- StringReference
- Structure
- StructureMember
- Symbol
- Transform
- TransformParameter
- Type
- TypeParserResult
- UndoAction
- UpdateChannel
- UpdateProgressCallback
- UpdateVersion
-
-.. toctree::
- :maxdepth: 2
-
-.. automodule:: binaryninja
- :members:
- :undoc-members:
- :show-inheritance: