.. DocumentValidator documentation master file, created by
   sphinx-quickstart on Sun Oct 13 13:50:32 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

DocumentValidator: an inspection tool for technical documents
==============================================================

DocumentValidator is a tool to help a writer or programmer who writes technical documents or manuals that adheres to a writing standard. DocumentValidator automates the verfications of input documents written in natural languages (NOT computer languges such as C++ or Java). It works as the same way as CheckStyle, a code inspection tool for Java Language. Users add validators each of which checkes one aspect of the input document into the configuration file, and then following the configurations, this tool does the validation.

.. Note::
   This project is young, but I will update periodically as it is completed.

.. toctree::
   :hidden:

   quickstart
   command
   configuration

Links
======

- `Source <https://github.com/takahi-i/document-validator/>`_
- `Issue <https://github.com/takahi-i/document-validator/issues?state=open>`_


.. DocumentValidator documentation master file, created by
   sphinx-quickstart on Sun Oct 13 13:50:32 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

DocumentValidator: an inspection tool for technical documents
==============================================================

DocumentValidator is a tool to help a writer or programmer who writes technical documents or manuals that adheres to a writing standard. DocumentValidator automates the verfications of input documents written in natural languages (**NOT** computer languges such as C++ or Java). It works as the same way as `CheckStyle`_ , a famous code inspection tool for Java. Users add validators each of which checkes one aspect of the input document into the configuration file, and then following the configurations, this tool does the validation.

.. _CheckStyle:  http://checkstyle.sourceforge.net/

.. Note::
   This project is young, but I will update periodically as it is completed.

.. toctree::
   :hidden:

   quickstart
   command
   configuration

Links
======

- `Source <https://github.com/takahi-i/document-validator/>`_
- `Issue <https://github.com/takahi-i/document-validator/issues?state=open>`_


Add a link to checkstyle page
Add a link to checkstyle page
