"Fossies" - the Fresh Open Source Software Archive

Member "flatbuffers-23.1.21/docs/source/README_TO_GENERATE_DOCS.md" (21 Jan 2023, 1060 Bytes) of package /linux/misc/flatbuffers-23.1.21.tar.gz:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the last Fossies "Diffs" side-by-side code changes report for "README_TO_GENERATE_DOCS.md": 22.11.23_vs_22.12.06.


To generate the docs for FlatBuffers from the source files, you will first need to install two programs.

  1. You will need to install doxygen. See Download Doxygen.

  2. You will need to install doxypypy to format python comments appropriately. Install it from here.

Note: You will need both doxygen and doxypypy to be in your PATH environment variable.

After you have both of those files installed and in your path, you need to set up the py_filter to invoke doxypypy from doxygen.

Follow the steps here.

Generating Docs

Run the following commands to generate the docs:

cd flatbuffers/docs/source doxygen

The output is placed in flatbuffers/docs/html.

Note: The Go API Reference code must be generated ahead of time. For instructions on how to regenerated this file, please read the comments in GoApi.md.