Home | History | Annotate | only in /external/flatbuffers/docs/source
Up to higher level directory
NameDateSize
Benchmarks.md21-Aug-20184.8K
Building.md21-Aug-20182.9K
Compiler.md21-Aug-20185.1K
CONTRIBUTING.md21-Aug-20182.2K
CppUsage.md21-Aug-201820.6K
CUsage.md21-Aug-20188.1K
doxyfile21-Aug-201899.9K
doxygen_layout.xml21-Aug-20188K
FlatBuffers.md21-Aug-20188.3K
FlexBuffers.md21-Aug-20186.9K
GoApi.md21-Aug-20181.2K
GoApi_generated.txt21-Aug-20184.5K
GoUsage.md21-Aug-20183.7K
Grammar.md21-Aug-20181.7K
groups21-Aug-2018576
gRPC/21-Aug-2018
Internals.md21-Aug-201819.3K
JavaCsharpUsage.md21-Aug-20186.9K
JavaScriptUsage.md21-Aug-20184K
PHPUsage.md21-Aug-20183.3K
PythonUsage.md21-Aug-20183.9K
README_TO_GENERATE_DOCS.md21-Aug-20181.1K
Schemas.md21-Aug-201823.9K
style.css21-Aug-20185.4K
Support.md21-Aug-20182.7K
Tutorial.md21-Aug-201866.9K
WhitePaper.md21-Aug-20185.6K

README_TO_GENERATE_DOCS.md

      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