Contributing Documentation¶
Documentation is published at http://wymeditor.readthedocs.org/
.
WYMeditor’s documentation is written for the Sphinx documentation generator. In order to build the documentation, it must be installed.
Building and Opening the Documentation¶
Building the documentation is as easy as:
$ grunt docsMake
Opening the documentation in the default browser:
$ grunt docsOpen
Building and opening, in succession, in one command:
$ grunt docs
Documentation Source Files¶
The source files of the documentation are at docs
.
The only exception is
the readme file, README.rst
,
which is at the root of the repository.
It is included in the build
and serves as about_wymeditor
.
The Sphinx configuration file, conf.py
,
and the Makefile
are there, as well.