OMNeT++ doc-builder

doc-builder builds the documentation website of an OMNeT++ model project, ready for GitHub Pages, with the toolchain of doc.omnetpp.org and inet.omnetpp.org:

  • the NED reference of the project’s NED and MSG files, generated by opp_docgen;

  • optionally a Sphinx site, the hand-written documentation that the NED reference becomes part of;

  • optionally the C++ API, generated by doxygen, linked from the pages of the NED types;

  • optionally PDFs of the Sphinx site.

It is a GitHub Action, omnetpp/doc-builder, which runs the build in the ghcr.io/omnetpp/doc-builder container image. The same build runs on your machine, too.

This site is an example of what it builds

This site is built by the action from the site/ directory of its repository, which is a small model project: a source, a queueing node and a sink. Its pages are the documentation of the action; the NED Reference and the C++ Reference are those of the model.

The tabs of the site show the ways the tabs can be navigated:

  • Home, this page, opens no menu;

  • Getting Started opens its pages as a menu, and has the navigation sidebar on the left;

  • Configuration is navigated by its menu alone, without the sidebar;

  • Reference has the trees of the NED reference and the C++ API in the sidebar.

Navigation tells which settings do this, and Variants of This Site shows the site with settings that apply to all tabs.

Where to start