Skip to content

lorenzo-gomez-windhover/airliner-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Dependencies

  1. pip3 install sphinx
  2. pip3 install breathe
  3. pip3 install zerovm-sphinx-theme

To build.

  1. cd build/reference/default/docs
  2. make html

To open up the documentation you can run this command xdg-open build/html/index.html

Note that files such as the ones on build/reference/default/docs/source/apps/lc/detailed_design/struct are NOT generated by make html

These were generated by a tool called breathe-apidoc which parses xml doxygen-generated files to rst files and enables us to link to structs/classes/data structures that exists on our doxygen docs with very simple syntax from rst files.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published