diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2018-11-26 22:48:18 -0500 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2018-11-26 22:48:18 -0500 |
| commit | f6b36a82a9fa7428c7e136f5ef101f846fd326e8 (patch) | |
| tree | 7e1459afa48d2aa3c52b3e3f0b91688948403e53 | |
| parent | 5f7f0c4624dc51e1ccc44eb839860e36490e54ce (diff) | |
only include specific version in one file to minimize update churn
| -rw-r--r-- | api-docs/source/conf.py | 13 | ||||
| -rw-r--r-- | sphinx_rtd_theme/layout.html | 17 |
2 files changed, 12 insertions, 18 deletions
diff --git a/api-docs/source/conf.py b/api-docs/source/conf.py index ac07f7fd..854a2859 100644 --- a/api-docs/source/conf.py +++ b/api-docs/source/conf.py @@ -29,7 +29,6 @@ else: sys.path.insert(0, bnpath) import binaryninja binaryninja._init_plugins() #force license check -binaryninja.core_serial = "REDACTED" def modulelist(modulename): modules = inspect.getmembers(modulename, inspect.ismodule) @@ -144,8 +143,8 @@ author = u'Vector 35 LLC' # built documents. # # The short X.Y version. -version = u'.'.join(unicode(binaryninja.core_version).split('.')[0:2]) -release = unicode(binaryninja.core_version) +version = u'.'.join(unicode(binaryninja.core_version()).split('.')[0:2]) +release = unicode(binaryninja.core_version()) language = 'en' @@ -192,11 +191,11 @@ html_theme_path = [os.path.join(os.path.abspath("."), "..", "..")] # The name for this set of Sphinx documents. # "<project> v<release> documentation" by default. # -# html_title = u'Binary Ninja Documentation v1.0.1' +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 = None +html_short_title = u'BN API' # The name of an image file (relative to this directory) to place at the top # of the sidebar. @@ -207,7 +206,7 @@ html_theme_path = [os.path.join(os.path.abspath("."), "..", "..")] # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # -# html_favicon = None +html_favicon = u'../../docs/img/favicon.ico' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -258,7 +257,7 @@ html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # -# html_show_sphinx = True +html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index fe669206..1693e79e 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -109,7 +109,12 @@ {% endif %} {% if nav_version %} <div class="version"> - {{ nav_version }} + <script> + window.addEventListener("load", function() { + var ver = document.getElementsByClassName("version"); + ver[0].innerHTML = DOCUMENTATION_OPTIONS['VERSION']; + }); + </script> </div> {% endif %} {% endif %} @@ -164,16 +169,6 @@ {% if not embedded %} -<!-- <script type="text/javascript"> - var DOCUMENTATION_OPTIONS = { - URL_ROOT:'{{ url_root }}', - VERSION:'{{ release|e }}', - COLLAPSE_INDEX:false, - FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}', - HAS_SOURCE: {{ has_source|lower }} - }; - </script> ---> {% if sphinx_version >= "1.8.0" %} <script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script> {%- for scriptfile in script_files %} |
