diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2022-10-17 06:23:08 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2022-10-17 06:23:08 -0400 |
| commit | 4942700ca3387b64cc6443a80bac60b470588bb9 (patch) | |
| tree | 7ab0b29c72e9146734b3cb24d062dff148c2b8ec /docs/dev/documentation.md | |
| parent | fba5ef5a7cb2c0f76cf2531adddda9d3023c2357 (diff) | |
documentation overhaul
Diffstat (limited to 'docs/dev/documentation.md')
| -rw-r--r-- | docs/dev/documentation.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md index 16a1c9ee..b524d7fb 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -26,7 +26,7 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li ## Changing Changing documentation for the API itself is fairly straight forward. Use [doxygen style comment blocks](https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html) in C++ and C, and [restructured text blocks](http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html) for python for the source. The user documentation is located in the `api/docs/` folder and the API documentation is generated from the config in the `api/api-docs` folder. -!!! Tip "Tip" +???+ Warning "Tip" When updating user documentation, the `mkdocs serve` feature is particularly helpful. [contribution license agreement]: https://binary.ninja/cla.pdf |