Chapel Documentation
====================

This directory contains Chapel's documentation in two formats:

``html/`` is generated by the ``make docs`` command and contains a web-rendered 
format of the documentation, which reflects the online documentation hosted at 
``https://chapel-lang.org/docs``. This can be viewed by pointing a web browser 
of your choice to ``html/index.html``.

``rst/`` contains the documentation in the format of reStructuredText (rst), a
markup language. This documentation can be viewed with a text editor of your
choice.

Note that some files in ``rst/`` are written or generated for the purpose of
being rendered as HTML, such as the ``modules/`` and ``builtins/`` directory,
as well as the ``index.rst`` files. For this reason, we recommend browsing the
documentation in the web format.

Resources
---------

Here are some useful resources available in ``{rst,html}/``:

====================================  ========================================
Building from source                  ``usingchapel/QUICKSTART.{rst,html}``
Platform-specific notes               ``platforms/``
Setting Chapel environment variables  ``usingchapel/chplenv.{rst,html}``
Building the compiler                 ``usingchapel/building.{rst,html}``
Compiling Chapel programs             ``usingchapel/compiling.{rst,html}``
Executing Chapel programs             ``usingchapel/executing.{rst,html}``
Debugging Chapel programs             ``usingchapel/debugging.{rst,html}``
Reporting bugs                        ``usingchapel/bugs.{rst,html}``
Users guide                           ``users-guide/``
Sample computations                   ``examples/``
Sample of language features           ``primers/``
====================================  ========================================

