diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2023-03-26 18:46:35 -0700 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2023-03-26 18:46:35 -0700 |
| commit | 3813004537f05133fc4bff09eefdf11723848ddf (patch) | |
| tree | c4f1da9fc8474f6332be25c500ff4030f92626e8 | |
| parent | a8fc598fc81cbdc3392b39285c27c7140b768e33 (diff) | |
offline search in user guide and optional stats tracking for online docs
| -rw-r--r-- | api-docs/source/conf.py | 12 | ||||
| -rw-r--r-- | mkdocs.yml | 6 | ||||
| -rw-r--r-- | overrides/partials/integrations/custom.html | 3 |
3 files changed, 19 insertions, 2 deletions
diff --git a/api-docs/source/conf.py b/api-docs/source/conf.py index 642cfce4..d511b85e 100644 --- a/api-docs/source/conf.py +++ b/api-docs/source/conf.py @@ -23,6 +23,16 @@ import platform import inspect import glob +stats = ''' + +.. raw:: html + +<!-- Remove for online stats +<script async defer data-website-id="5e56a9cf-8d67-4345-8cf4-408850b1549e" src="https://stats.ext.v35.us/yummi.js"></script> +--> + +''' + if (platform.system() == "Darwin"): bnpath=os.path.join(os.path.abspath('.'), "..", "..", "..", "build", "out", "binaryninja.app", "Contents", "Resources", "python") else: @@ -132,8 +142,10 @@ Full Class List :members: :undoc-members: :show-inheritance:''') + modulefile.write(stats) modulefile.close() + pythonrst.write(stats) pythonrst.close() @@ -4,13 +4,14 @@ repo_url: 'https://binary.ninja/' repo_name: 'binary.ninja' site_description: 'Documentation for the Binary Ninja reverse engineering platform' site_author: 'Vector 35 Inc' -google_analytics: ['UA-72420552-3', 'docs.binary.ninja' ] -use_directory_urls: False +use_directory_urls: false extra_css: ['docs.css', 'github.min.css', 'juxtapose.min.css'] extra_javascript: ['highlight.min.js', 'cpp.min.js', 'python.min.js', 'juxtapose.min.js'] theme: name: material + custom_dir: overrides favicon: 'img/favicon.ico' + font: false highlightjs: false palette: scheme: binja @@ -33,6 +34,7 @@ theme: plugins: - search + - offline markdown_extensions: - codehilite diff --git a/overrides/partials/integrations/custom.html b/overrides/partials/integrations/custom.html new file mode 100644 index 00000000..50e849e6 --- /dev/null +++ b/overrides/partials/integrations/custom.html @@ -0,0 +1,3 @@ +<!-- REMOVE FOR ONLINE STATS TRACKING ONLY +<script async defer data-website-id="b82b5f79-150b-410b-b2db-068b97c7dc6a" src="https://stats.ext.v35.us/yummi.js"></script> +--> |