summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2020-10-21 15:54:58 -0400
committerJordan Wiens <jordan@psifertex.com>2020-10-21 15:54:58 -0400
commit2a10520473cb1336cceca2da250013b21f1a2a51 (patch)
treefe4bfbaa79b76f7d73197054bb39ea72d953a57e
parentde82cc2cc17329530e015368b50862e381d68659 (diff)
add readme to cpp docs and update plugin documentation to refer to the new menu
-rw-r--r--api-docs/cppdocs/README.md24
-rw-r--r--docs/guide/plugins.md2
2 files changed, 25 insertions, 1 deletions
diff --git a/api-docs/cppdocs/README.md b/api-docs/cppdocs/README.md
new file mode 100644
index 00000000..237a840c
--- /dev/null
+++ b/api-docs/cppdocs/README.md
@@ -0,0 +1,24 @@
+# CPP Docs
+
+We are currently expirmenting with two different document generation systems. You'll see artifacts for both of them in this directory. Currently, the documentation available [online](https://api.binary.ninja/cpp) uses [Doxygen](https://www.doxygen.nl/index.html) but we plan eventually to move to [Breathe](https://breathe.readthedocs.io/en/latest/) / [Sphinx](https://www.sphinx-doc.org/en/master/).
+
+## Doxygen
+
+Generating documentation with Doxygen couldn't be simpler. Just install it and run:
+
+```
+$ doxygen
+```
+
+From this directory. The output will be stored in `html/`
+
+
+## Breathe/Sphinx
+
+The requirements are already described in our [documentation](https://docs.binary.ninja/dev/documentation.html). Instead, however simply navigate to this directory and use:
+
+```
+sphinx-build -b html . html/
+```
+
+Note that Sphinx will take significantly longer due to some performance issues with breathe and doxygen generated XML. This is the main reason this is not our primary workflow.
diff --git a/docs/guide/plugins.md b/docs/guide/plugins.md
index 4602ca02..452802d3 100644
--- a/docs/guide/plugins.md
+++ b/docs/guide/plugins.md
@@ -115,7 +115,7 @@ Additionally, running a python plugin with an environment variable of `BN_DISABL
## Writing Plugins
-First, take a look at some of the [example] plugins, or some of the [community] plugins to get a feel for different APIs you might be interested in. Of course, the full [API] docs are online and available offline via the `Help`/`Open API Reference...`.
+First, take a look at some of the [example] plugins, or some of the [community] plugins to get a feel for different APIs you might be interested in. Of course, the full [API] docs are online and available offline via the `Help`/`Open Python Reference...`.
To start, we suggest you download the [sample plugin] as a template since it contains all of the elements you're likely to need.