summaryrefslogtreecommitdiff
path: root/docs/dev/documentation.md
diff options
context:
space:
mode:
authorRusty Wagner <rusty@vector35.com>2018-08-28 17:19:32 -0400
committerRusty Wagner <rusty@vector35.com>2018-08-28 17:19:32 -0400
commit20e06506a3d96c7327ca5d729ab01e8c2a7cff3c (patch)
tree65880063ccbdcb45cc247a0138915d8560d2ec27 /docs/dev/documentation.md
parent5841af2db8e8dcf4e0da0c438ac040c5fa90038b (diff)
parent426bb3d8b47b93658bf969c429a8b98adae13c30 (diff)
Merge branch 'dev' into test_stack_adjust
Diffstat (limited to 'docs/dev/documentation.md')
-rw-r--r--docs/dev/documentation.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md
index 830bd4ec..16a1c9ee 100644
--- a/docs/dev/documentation.md
+++ b/docs/dev/documentation.md
@@ -27,7 +27,7 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li
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"
- When updating user documentation, the `mkdoc serve` feature is particularly helpful.
+ When updating user documentation, the `mkdocs serve` feature is particularly helpful.
[contribution license agreement]: https://binary.ninja/cla.pdf
[Vector 35]: https://vector35.com/