diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2016-07-26 01:16:24 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2016-07-26 01:16:24 -0400 |
| commit | bea7670c316e042fc64d372024252aff04047dec (patch) | |
| tree | 5ef30702a2bfdb1071ec205022956b7e84e53da5 | |
| parent | a731394cb5e9b0f0d7e4cce9230e15340c5e67af (diff) | |
switch sphinx to rtd and upate paths
| -rw-r--r-- | api-docs/source/conf.py | 18 | ||||
| -rw-r--r-- | docs/about/open-source.md | 3 |
2 files changed, 14 insertions, 7 deletions
diff --git a/api-docs/source/conf.py b/api-docs/source/conf.py index 11a1610f..1b3e5bf6 100644 --- a/api-docs/source/conf.py +++ b/api-docs/source/conf.py @@ -18,11 +18,15 @@ # import os import sys -bnpath=os.path.join(os.path.abspath('.'), "..", "..", "python") -print "PATH: %s" % bnpath +import platform + +if (platform.system() == "Darwin"): + bnpath=os.path.join(os.path.abspath('.'), "..", "..", "..", "ui", "binaryninja.app", "Contents", "Resources", "python") +else: + bnpath=os.path.join(os.path.abspath('.'), "..", "..", "..", "ui", "python") + sys.path.insert(0, bnpath) import binaryninja -import sphinx_theme_pd # -- General configuration ------------------------------------------------ @@ -48,9 +52,9 @@ extensions = [ autosummary_generate = True autodoc_member_order = 'groupwise' -breathe_projects = { "BinaryNinja": "../../api/xml/" } +breathe_projects = { "BinaryNinja": "../../xml/" } breathe_projects_source = { - "BinaryNinja": ("../../api/", ["binaryninjaapi.h", "binaryninjacore.h"]) + "BinaryNinja": ("../../", ["binaryninjaapi.h", "binaryninjacore.h"]) } breathe_default_project = "BinaryNinja" @@ -142,8 +146,8 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_theme_pd' -html_theme_path = [sphinx_theme_pd.get_html_theme_path()] +html_theme = 'sphinx_rtd_theme' +html_theme_path = [os.path.join(os.path.abspath("."), "..", "..")] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/about/open-source.md b/docs/about/open-source.md index 701f49e5..529a18e6 100644 --- a/docs/about/open-source.md +++ b/docs/about/open-source.md @@ -11,6 +11,7 @@ The following tools are used in the generation of our documentation, but are not - [mkdocs] ([mkdocs license] - BSD) - [mkdocs-material] ([mkdocs-material License] - BSD) - [breathe] ([breathe license] - BSD) + - [breathe-rtd-theme] ([breathe-rtd-theme license] - MIT) - [sphinx] ([sphinx license] - BSD and others) - [doxygen] ([doxygen license] - GPLv2) @@ -49,6 +50,8 @@ Please note that we offer no support for running Binary Ninja with modified Qt l [mkdocs-material license]: https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE [breathe]: https://github.com/michaeljones/breathe [breathe license]: https://github.com/michaeljones/breathe/blob/master/LICENSE +[breathe-rtd-theme]: https://github.com/snide/sphinx_rtd_theme/ +[breathe-rtd-theme license]: https://github.com/snide/sphinx_rtd_theme/blob/master/LICENSE [sphinx]: http://www.sphinx-doc.org/en/stable/index.html [sphinx license]: https://github.com/sphinx-doc/sphinx/blob/master/LICENSE [doxygen]: http://www.stack.nl/~dimitri/doxygen/ |
