Start Icarus Verilog Documentation using Sphinx

Embed the Icarus Verilog documentation, and format it so that the
Sphinx tools can process it into html or other formats. This will
make the documentation easier to keep up to date with the actual
software.

Documentation/.gitignore

@@ -0,0 +1 @@
+_build/

Documentation/conf.py

@@ -0,0 +1,155 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Icarus Verilog'
+copyright = '2022, Stephen Williams'
+author = 'Stephen Williams'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'IcarusVerilogdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'IcarusVerilog.tex', 'Icarus Verilog Documentation',
+     'Stephen Williams', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'icarusverilog', 'Icarus Verilog Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'IcarusVerilog', 'Icarus Verilog Documentation',
+     author, 'IcarusVerilog', 'One line description of project.',
+     'Miscellaneous'),
+]

Documentation/developer/index.rst

@@ -0,0 +1,12 @@
+
+Icarus Verilog Developer Support
+================================
+
+This section contains documents to help support developers who contribute to
+Icarus Verilog.
+
+.. toctree::
+   :maxdepth: 1
+
+   version_stamps
+

Documentation/developer/version_stamps.rst

@@ -0,0 +1,29 @@
+
+Files With Version Information
+=============================
+
+These are the only files that have version information in them:
+
+* version_base.h    -- This should be the 1 source for version info.
+* version_tag.h     -- Generated automatically with git tag information.
+* verilog.spec      -- Used to stamp RPM packages
+
+When versions are changed, the above files need to be edited to account for
+the new version information. The following used to have verion information in
+them, but now their version information is generated:
+
+Replaced with version_base.h, which is edited manually, and
+version_tag.h which is generated from git tag information.
+
+* version-base.in     -- Most compiled code gets version from here
+
+These are now edited by the makefile and the version.exe program.
+
+* iverilog-vpi.man    -- The .TH tag has a version string
+* driver/iverilog.man -- The .TH tag has a version string
+* driver-vpi/res.rc   -- Used to build Windows version stamp
+* vvp/vvp.man         -- The .TH tag has a version string
+
+This now includes version_base.h to get the version
+
+* vpi/vams_simparam.c -- Hard coded result to simulatorVersion query

Documentation/index.rst

@@ -0,0 +1,25 @@
+.. Icarus Verilog documentation master file, created by
+   sphinx-quickstart on Sun Apr 10 16:28:38 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Icarus Verilog
+==============
+
+Welcome to the documentation for Icarus Verilog.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   usage/index
+   targets/index
+   developer/index
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

Documentation/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=IcarusVerilog
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

Documentation/targets/index.rst

@@ -0,0 +1,16 @@
+
+The Icarus Verilog Targets
+==========================
+
+Icarus Verilog elaborates the design, then sends to the design to code
+generates (targets) for processing. new code generators can be added by
+external packages, but these are the code generators that are bundled with
+Icarus Verilog. The code generator is selected by the "-t" command line flag.
+
+.. toctree::
+   :maxdepth: 1
+
+   vvp
+   stub
+   null
+

Documentation/targets/null.rst

@@ -0,0 +1,7 @@
+
+The null Code Generator (-tnull)
+================================
+
+The null target generates no code. Invoking this code generator causes no code
+generation to happen.
+

Documentation/targets/stub.rst

@@ -0,0 +1,7 @@
+
+The stub Code Generator (-tstub)
+==============================
+
+The stub code generator is a debugging aid for the Icarus Verilog compiler
+itself. It outputs a text dump of the elaborated design as it is passed to
+code generators.

Documentation/targets/vvp.rst

@@ -0,0 +1,6 @@
+
+The vvp Code Generator (-tvvp)
+==============================
+
+The vvp target generates code for the "vvp" run time. This is the most
+commonly used target for Icarus Verilog, as it is the main simulation engine.