openstack-manuals/doc/contributor-guide/source/doc-tools/installation.rst
KATO Tomoyuki 057cad023b [contributor] reorganize documentation tools
Reorganizes the Documentation tools section basing on
the principles of topic-based authoring.

Co-Authored-By: OlgaGusarenko <ogusarenko@mirantis.com>

Change-Id: I2f23828672dea091279ee53650275ed9ca48705b
Implements: blueprint contributor-guide-reorg
2016-07-20 01:56:08 +00:00

707 B

Install OpenStack documentation tools

To install the documentation toolkit:

  1. Verify that you have installed the prerequisites.

  2. Install the openstack-doc-tools package:

    $ pip install openstack-doc-tools

    If you have virtualenvwrapper installed, run:

    $ mkvirtualenv openstack-doc-tools
    $ pip install openstack-doc-tools
  3. To use openstack-doc-tools, import the tools to a project:

    import os_doc_tools