diff options
| author | Jordan Wiens <github@psifertex.com> | 2025-11-10 23:29:37 -0500 |
|---|---|---|
| committer | Jordan Wiens <github@psifertex.com> | 2025-11-10 23:29:37 -0500 |
| commit | dcbe7bd0349f38dbca080e219ea3b5c92983d71f (patch) | |
| tree | af20b454ea59f118e0faaaa17bb40c1331d04fd1 /docs | |
| parent | f4f7de736ab1c13782bae3b10535e780eb15c108 (diff) | |
update rst doc link
Diffstat (limited to 'docs')
| -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 f6d6c9ac..08053c24 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -23,7 +23,7 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li echo API documentation available in build/html ## Changing -Changing documentation for the API itself is fairly straight forward. Use [doxygen style comment blocks](https://www.doxygen.nl/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. +Changing documentation for the API itself is fairly straight forward. Use [doxygen style comment blocks](https://www.doxygen.nl/manual/docblocks.html) in C++ and C, and [restructured text blocks](https://sphinx-tutorial.readthedocs.io/step-1/) 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. ???+ Info "Tip" When updating user documentation, the `mkdocs serve` feature is particularly helpful. |
