• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1## Prerequisites
2
3To generate the docs for FlatBuffers from the source files, you
4will first need to install two programs.
5
61. You will need to install `doxygen`. See
7   [Download Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html).
8
92. You will need to install `doxypypy` to format python comments appropriately.
10   Install it from [here](https://github.com/Feneric/doxypypy).
11
12*Note: You will need both `doxygen` and `doxypypy` to be in your
13[PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable.*
14
15After you have both of those files installed and in your path, you need to
16set up the `py_filter` to invoke `doxypypy` from `doxygen`.
17
18Follow the steps
19[here](https://github.com/Feneric/doxypypy#invoking-doxypypy-from-doxygen).
20
21## Generating Docs
22
23Run the following commands to generate the docs:
24
25`cd flatbuffers/docs/source`
26`doxygen`
27
28The output is placed in `flatbuffers/docs/html`.
29
30*Note: The Go API Reference code must be generated ahead of time. For
31instructions on how to regenerated this file, please read the comments
32in `GoApi.md`.*
33