.. ===============LICENSE_START=======================================================
.. Acumos CC-BY-4.0
.. ===================================================================================
.. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
.. ===================================================================================
.. This Acumos documentation file is distributed by AT&T and Tech Mahindra
.. under the Creative Commons Attribution 4.0 International License (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..
.. http://creativecommons.org/licenses/by/4.0
..
.. This file is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
.. ===============LICENSE_END=========================================================

.. _rst-tools:

=======================================
Tools for Creating Documentation in RST
=======================================

Editing Tools
=============

Ubuntu
------

#. `ReText <https://github.com/retext-project/retext/>`_: Ubuntu Software Store or follow the instructions on the project's `Github <https://github.com/retext-project/retext/>`_ page; ReText has a live preview feature 
#. `Atom <https://atom.io/>`_ with the RST-Preview Package
#. `Notepadqq <https://notepadqq.com/>`_
#. gedit

All Platforms
-------------
#. `ReST Editor for Eclipse <https://marketplace.eclipse.org/content/rest-editor/>`_
#. `Visual Studio Code <http://code.visualstudio.com/>`_ with the `vscode-restructuredtext <https://github.com/lextm/vscode-restructuredtext/>`_ extension
#. `VIM <https://www.vim.org/>`_

    #. `reStructuredText syntax highlighting mode <http://www.vim.org/scripts/script.php?script_id=973/>`_
    #. `VST <http://www.vim.org/scripts/script.php?script_id=1334/>`_ (Vim reStructuredText) plugin for Vim7 with folding.
    #. `VOoM plugin <http://www.vim.org/scripts/script.php?script_id=2657/>`_ for Vim that emulates two-pane outliner with support for reStructuredText (since version 4.0b2).
    #. `Riv: Take notes in rst <https://github.com/Rykka/riv.vim/>`_ Vim plugin to take notes in reStructured text.

#. `Emacs <http://www.gnu.org/software/emacs/emacs.html/>`_ with `rst-mode <http://docutils.sourceforge.net/docs/user/emacs.html/>`_ turned on
#. `PyCharm <https://www.jetbrains.com/pycharm/download/>`_
#. `Atom <https://atom.io/>`_ with `RST plugins <https://atom.io/packages/search?utf8=%E2%9C%93&q=keyword:rst>`_

Web-based Editors
-----------------
#. `NoTex <https://www.notex.ch/editor/>`_ - it can handle complete projects. You can upload your files and edit stuff.
#. `Online reStructuredText Editor <http://rst.ninjs.org/>`_ - It does not support all reST constructs (like the ``.. codeblock::`` directive),


Screen Capture and Edit
=======================
Ubuntu
------

#. `Shutter <http://shutter-project.org/>`_: Ubuntu Software Store or from PPA instructions on the project's website

Mac
---
#. `Greenshot <http://getgreenshot.org/>`_: Mac App Store ($1.99)


Windows
-------
#. `Greenshot <http://getgreenshot.org/>`_ (free)