Up to higher level directory | |||
Name | Date | Size | |
---|---|---|---|
Benchmarks.md | 06-Dec-2017 | 4.8K | |
Building.md | 06-Dec-2017 | 2.9K | |
Compiler.md | 06-Dec-2017 | 4.9K | |
CONTRIBUTING.md | 01-Jan-1970 | 0 | |
CppUsage.md | 06-Dec-2017 | 17.4K | |
CUsage.md | 06-Dec-2017 | 8.1K | |
doxyfile | 06-Dec-2017 | 99.9K | |
doxygen_layout.xml | 06-Dec-2017 | 7.8K | |
FlatBuffers.md | 06-Dec-2017 | 8.3K | |
FlexBuffers.md | 06-Dec-2017 | 6.6K | |
GoApi.md | 06-Dec-2017 | 1.2K | |
GoApi_generated.txt | 06-Dec-2017 | 4.5K | |
GoUsage.md | 06-Dec-2017 | 3.7K | |
Grammar.md | 06-Dec-2017 | 1.4K | |
groups | 06-Dec-2017 | 576 | |
Internals.md | 06-Dec-2017 | 18.9K | |
JavaCsharpUsage.md | 06-Dec-2017 | 6.9K | |
JavaScriptUsage.md | 06-Dec-2017 | 4K | |
PHPUsage.md | 06-Dec-2017 | 3.3K | |
PythonUsage.md | 06-Dec-2017 | 2.8K | |
README_TO_GENERATE_DOCS.md | 06-Dec-2017 | 1.1K | |
Schemas.md | 06-Dec-2017 | 23K | |
style.css | 06-Dec-2017 | 5.4K | |
Support.md | 06-Dec-2017 | 2.7K | |
Tutorial.md | 06-Dec-2017 | 64.3K | |
WhitePaper.md | 06-Dec-2017 | 5.6K |
1 ## Prerequisites 2 3 To generate the docs for FlatBuffers from the source files, you 4 will first need to install two programs. 5 6 1. You will need to install `doxygen`. See 7 [Download Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html). 8 9 2. 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 15 After you have both of those files installed and in your path, you need to 16 set up the `py_filter` to invoke `doxypypy` from `doxygen`. 17 18 Follow the steps 19 [here](https://github.com/Feneric/doxypypy#invoking-doxypypy-from-doxygen). 20 21 ## Generating Docs 22 23 Run the following commands to generate the docs: 24 25 `cd flatbuffers/docs/source` 26 `doxygen` 27 28 The output is placed in `flatbuffers/docs/html`. 29 30 *Note: The Go API Reference code must be generated ahead of time. For 31 instructions on how to regenerated this file, please read the comments 32 in `GoApi.md`.* 33