summaryrefslogtreecommitdiff
path: root/api-docs/source
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2024-01-08 13:50:10 -0500
committerJordan Wiens <jordan@psifertex.com>2024-01-08 13:50:10 -0500
commita3eee861692f2a0c90564897f9eefaa70e813547 (patch)
treeeadfacdd79343930dcefd52566e8bf78c679a834 /api-docs/source
parent5e08d0b323e05642783808d22f3e21d3dfbb5ee2 (diff)
Revert "clarify linux and demo setup"
This reverts commit 869785ff2ee9b83731b9f8451f8aa4372d74c31e.
Diffstat (limited to 'api-docs/source')
-rw-r--r--api-docs/source/_static/css/other.css78
-rw-r--r--api-docs/source/conf.py26
2 files changed, 12 insertions, 92 deletions
diff --git a/api-docs/source/_static/css/other.css b/api-docs/source/_static/css/other.css
index b0498fc6..cb820486 100644
--- a/api-docs/source/_static/css/other.css
+++ b/api-docs/source/_static/css/other.css
@@ -1,8 +1,6 @@
-/*
.wy-nav-content {
max-width: 2000px !important;
}
-*/
.cpplink, .cpplink a, .cpplink a:visited{
color: #fff;
@@ -16,79 +14,3 @@
.colon {
display: none !important;
}
-
-
-.toctree-l1 a:visited,
-.toctree-l1 a:hover,
-.toctree-l1 a {
- color: #ccc;
-}
-
-.wy-nav-top {
- background-color: #d73726 !important;
- color: #fff !important;
-}
-
-.wy-nav-top a:visited,
-.wy-nav-top a:hover,
-.wy-nav-top a,
-.wy-side-nav-search a:visited,
-.wy-side-nav-search a:hover,
-.wy-side-nav-search a {
- color: #fff;
-}
-
-.md-header {
- background-color: #d73726;
-}
-
-.md-tabs {
- background-color: #d73726;
- color: #ffffff;
-}
-
-.headerlink,
-.md-typeset a,
-.md-nav__link,
-.md-nav__item {
- color: #d73726;
-}
-
-a.md-tabs__link,
-a.md_tabs__link:visited {
- color: #ffffff;
-}
-
-.md_tabs__link:hover {
- color: #cccccc;
-}
-
-.headerlink:hover,
-.md-typeset a:hover,
-.md-nav__link:hover,
-.md-nav__item:hover {
- color: #000000;
-}
-
-.md-source,
-.md-source:visited,
-.md-header__button,
-.md-header__button:visited {
- color: #ffffff;
-}
-
-.md-grid {
- max-width: 85%;
-}
-
-/* TODO: Cleanup above hacks and replace with fully theme-aware code like below. */
-
-[data-md-color-scheme="binja"] {
- --md-primary-fg-color: #d73726;
- --md-primary-bg-color: #ffffff;
- --md-primary-fg-color--light: #ECB7B7;
- --md-primary-fg-color--dark: #990000;
- --md-code-fg-color: rgb(215, 55, 38);
- --md-code-bg-color: hsla(0, 0%, 96%, 1);
- --md-typeset-a-color: #000000;
-}
diff --git a/api-docs/source/conf.py b/api-docs/source/conf.py
index 75bc3eac..cfab6194 100644
--- a/api-docs/source/conf.py
+++ b/api-docs/source/conf.py
@@ -59,7 +59,7 @@ def modulelist(module, basename=""):
modules = inspect.getmembers(module, inspect.ismodule)
# We block the module named "debugger", because it is the folder that contains all debugger Python files
moduleblacklist = ["binaryninja", "core", "_binaryninjacore", "associateddatastore",
- "dbgcore", "_debuggercore", "_collaboration", "_ty"]
+ "dbgcore", "_debuggercore", "_collaboration"]
if basename != "":
basename += "."
@@ -181,12 +181,10 @@ extensions = [
'sphinx.ext.intersphinx',
'sphinxcontrib.jquery',
#'sphinx_tabs.tabs',
- 'sphinx.ext.viewcode',
- 'sphinx_immaterial',
+ 'sphinx.ext.viewcode'
]
simplify_optional_unions = True
-autoclass_content = 'both'
autodoc_typehints = 'both'
autosummary_generate = False
autodoc_member_order = 'groupwise'
@@ -213,7 +211,7 @@ master_doc = 'index'
# General information about the project.
project = u'Binary Ninja Python API'
-copyright = u'2015-2024, Vector 35 Inc'
+copyright = u'2015-2023, Vector 35 Inc'
author = u'Vector 35 Inc'
# The version info for the project you're documenting, acts as replacement for
@@ -255,22 +253,22 @@ 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_immaterial'
-#html_theme_path = [os.path.join(os.path.abspath("."), "..", "..")]
+html_theme = 'sphinx_rtd'
+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
# documentation.
#
html_theme_options = {
- 'features': ['navigation.tracking', 'navigation.expand', 'toc.follow'],
- "palette": { "scheme": "binja", "accent": "red" }
+ 'display_version': True,
+ 'style_external_links': True,
+ 'collapse_navigation': True, #Change to have all modules expandable from the start
+ 'navigation_depth': 2,
+ 'titles_only': False,
+ 'sticky_navigation': False,
}
-object_description_options = [
- ("py:parameter", dict(include_fields_in_toc=False)),
-]
-
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
@@ -281,7 +279,7 @@ html_title = u'Binary Ninja API Documentation v' + version
# A shorter title for the navigation bar. Default is the same as html_title.
#
-html_short_title = u'Binary Ninja Python API Reference'
+html_short_title = u'BN API'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.