HTML Output Generation

HTML is the default option for Specador. The theme used on the frontend is Read the Docs.

HTML page of a Verilog module

HTML page of a SystemVerilog class

Add custom Table of Contents

The user has the ability to define a custom Table of Contents, in order to highlight different aspects of the documentation using -index argument.

The description file must follow the Sphinx index file format. The paths included in the index file must be provided afterwards using -attach argument.

Custom index.rst file description

API Specification
======================

.. toctree::
   :maxdepth: 5
   :caption: OVERVIEW DOCUMENTATION

   menu/description.md
   menu/features.md
   menu/programming.rst
   menu/timing.rst

.. toctree::
   :maxdepth: 2
   :caption: API DOCUMENTATION
   :titlesonly:

   index-tops.rst
   modules/index-modules.rst
   index-macros.rst

$ $DVT_HOME/bin/specador.sh ... -index /path/to/index.rst -attach /path/to/menu/dir

Important

All the paths specified in index file are relative to the specador_docs/source folder. The -attach argument simply copies the paths under this directory.