diff options
Diffstat (limited to 'docs/dev/documentation.md')
| -rw-r--r-- | docs/dev/documentation.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md index 08053c24..bc0a445e 100644 --- a/docs/dev/documentation.md +++ b/docs/dev/documentation.md @@ -8,15 +8,15 @@ To contribute to the Binary Ninja documentation, first sign the [contribution li - [sphinx] - [breathe] -- [mkdocs] +- [properdocs] - [doxygen] -- The following mkdocs plugins: `mkdocs-callouts mkdocs-click mkdocs-include-markdown-plugin mkdocs-material mkdocs-glightbox mkdocs-htmlproofer-plugin mkdocs-redirects` +- The following plugins: `mkdocs-callouts mkdocs-click mkdocs-include-markdown-plugin mkdocs-material mkdocs-glightbox mkdocs-htmlproofer-plugin mkdocs-redirects` ## Building git clone https://github.com/Vector35/binaryninja-api/ cd binaryninja-api - mkdocs build + properdocs build echo User documentation available in site/ cd api-docs make html @@ -26,11 +26,11 @@ 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.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. + When updating user documentation, the `properdocs serve` feature is particularly helpful. [contribution license agreement]: https://binary.ninja/cla.pdf [Vector 35]: https://vector35.com/ -[mkdocs]: http://www.mkdocs.org/ +[properdocs]: https://properdocs.org/ [breathe]: https://github.com/michaeljones/breathe [sphinx]: https://www.sphinx-doc.org/en/master/ [doxygen]: https://www.doxygen.nl |