diff options
| author | kat <katherine@vector35.com> | 2022-10-17 12:37:02 -0400 |
|---|---|---|
| committer | Kyle Martin <krm504@nyu.edu> | 2022-10-17 19:55:39 -0400 |
| commit | 070b1a17dd32a673fd96e645d47dd0ca3bf764c6 (patch) | |
| tree | 0e2e4d864dde75bb0e6391f0f070682e75edeeea /api-docs/cppdocs/README.md | |
| parent | d41f2296da756d3f1916f70fb1db2f67f1549b7c (diff) | |
[C++ docs] Several fixes, improvements, additions, and general cleanup
- Sort documentation into groups (aka. modules)
- Add DataRenderer, BinaryView, InstructionTextToken, Others docs
- Fixes stylesheet for documentation website
- New 'Deprecated' section listing deprecated items
- Re-add 'Files' listing
- Add a 'Main page' and restructure the navbar
Diffstat (limited to 'api-docs/cppdocs/README.md')
| -rw-r--r-- | api-docs/cppdocs/README.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/api-docs/cppdocs/README.md b/api-docs/cppdocs/README.md index 9a857d17..56412839 100644 --- a/api-docs/cppdocs/README.md +++ b/api-docs/cppdocs/README.md @@ -1,8 +1,8 @@ # CPP Docs -We are currently experimenting 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/). +We currently use `doxygen` for our C++ documentation generation. -## Doxygen +> Note: Using anything newer than doxygen 1.9.4 will cause minor issues with the website whenever the selected theme conflicts with the OS/browser light/dark mode selection. Generating documentation with Doxygen couldn't be simpler. Just install it and run: @@ -12,13 +12,13 @@ $ doxygen From this directory. The output will be stored in `html/` +## Installing doxygen -## Breathe/Sphinx +The theme for our documentation works best with doxygen 1.9.0 - 1.9.4 -The requirements are already described in our [documentation](https://docs.binary.ninja/dev/documentation.html). Instead, however simply navigate to this directory and use: +### macOS (Homebrew) ``` -sphinx-build -b html . html/ +wget https://raw.githubusercontent.com/Homebrew/homebrew-core/41828ee36b96e35b63b2a4c8cfc2df2c3728944a/Formula/doxygen.rb` +brew install ./doxygen.rb ``` - -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. |