diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2024-02-19 15:04:00 -0500 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2024-02-23 11:14:06 -0500 |
| commit | 448f40be71dffa86a6581c3696627ccc1bdf74f2 (patch) | |
| tree | cd79923c85986c0135b41eb7432e54218f1a56e5 /api-docs/source | |
| parent | 748c2295e31c03afa1d4b1b776a59f9fa9a48d34 (diff) | |
4.0 documentation
- Refactored Type Documentation
- Added Projects
- Added Type Archives
- Added New Sidebar Documentation
- Added String Concepts
- Added Light/Dark Mode
- Added New Tab Documentation
- Added BNIL Guide: HLIL docs
- Added new cookbook examples
- Added migration guide
- Added script for building docsets
- Added documentation for themes
- Updated all images to Ninja Edit
- API Docs : Documents BasicBlockEdge and BasicBlock
- API Docs : Documents CoreVariable, Variable, and VariableNameAndType
- API Docs : Corrects note on `BinaryView.update_analysis` and `BinaryView.update_analysis_and_wait` to represent that analysis is run by default for you now.
- Many, many other changes
Diffstat (limited to 'api-docs/source')
| -rw-r--r-- | api-docs/source/conf.py | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/api-docs/source/conf.py b/api-docs/source/conf.py index bc32e478..092710d5 100644 --- a/api-docs/source/conf.py +++ b/api-docs/source/conf.py @@ -102,6 +102,15 @@ Welcome to the Binary Ninja API documentation. The below methods are available from the root of the `binaryninja` package, but most of the API is organized into the modules shown in the left side-bar. +These pages are intended as an API Reference. For a deeper explanation of how +different parts of Binary Ninja work, explanations of concepts, or if you're +new to Binary Ninja, you'll want to check out our [User Guide](https://docs.binary.ninja/). + +If you're new to our API, we also have a [Developer Guide](https://docs.binary.ninja/dev/index.html) +which covers many of the concepts developers should know. There's also a +[Cookbook](https://docs.binary.ninja/dev/cookbook.html) which contains many +examples to get you started using our API. + You can also scroll to the end to view a class list of all available classes. The search bar on the side works both online and offline. |