vir doc
=======

Create documentation for your project.

Usage
-----
.. code-block:: console

  $ vir doc
  Wrote docs to build/doc

``vir doc`` generates HTML documentation for your project's Virdant sources.
It writes the documentation to the ``build/doc`` directory of your project.

By default, all of your project's Virdant modules are considered documentation-worthy.

Options
-------
``--open``
    Open the generated documentation in your web browser after generation.

Next steps
----------
* :doc:`/tools/format`: Format your Virdant source files.
* :doc:`/tools/check`: Check a Virdant project for problems.