Intro
=====

.. image:: images/specador_page.png

Specador automatically generates accurate **HTML** and **PDF** documentation from Verilog/SystemVerilog,
VHDL and eLanguage source code by using dedicated language compilers.

The documentation is organized by language specific concepts, including both relationship and structural information. 
There are dedicated categories for packages, classes, entities or modules and one can easily 
explore the class inheritance, the design hierarchy or entity architectures.

.. toctree::
   :caption: How To 
   :maxdepth: 3

   Install                    <toc/installation>
   Run in Batch Mode          <toc/how-to-run/specador.sh>
   Run in DVT IDE for Eclipse <toc/how-to-run/eclipse>
   Run in DVT IDE for VS Code <toc/how-to-run/vscode>
   Compile                    <toc/compile-arguments/index.rst>

.. toctree::
   :caption: Features
   :maxdepth: 2

   Diagrams            <toc/features/diagrams.rst>
   Comments            <toc/features/comments.rst>
   AI Assistant        <toc/features/ai.rst>
   HTML Output         <toc/features/html.rst>
   PDF Output          <toc/features/pdf.rst>
   Preferences         <toc/features/customizations.rst>

.. toctree::
   :caption: Reference

   Output and logging   <toc/application-notes/output-and-logging.rst>
   Memory monitor       <toc/reference/memory-monitor.rst>

.. toctree::

   What is New?         <toc/whats-new/index.rst>
   Legal Notices        <toc/legal/index.rst>
   Third Party Licenses <toc/licenses/index.rst>