Commit Graph

12 Commits

Author SHA1 Message Date
Andreas Jaeger
01943b0637 Fix setup.cfg for rename of main in doctest
A recent change renamed main in doctest.py to doctest, this needs a
corresponding change in setup.cfg to fix package building.

Change-Id: Ic75db791af98b775a212e93b25548028f6d7ca53
2014-05-19 18:31:42 +02:00
Roger Luethi
3d61e98305 Add new script jsoncheck.py
Add a new script that can reformat JSON files and check for niceness.
We can use this later as niceness check for openstack-doc-test.

Change-Id: I33c5309bfa2e1abfa6a35d1cfcdc984775e85f05
2014-05-07 22:11:21 +02:00
Andreas Jaeger
b298591901 Remove compatibility names
These names are not used anymore, all usage has been adapted.

Change-Id: I8bf369956fbdd55a2696e28ae033837c6513fcca
2014-04-24 19:27:54 +02:00
Andreas Jaeger
ccbfdb592f Merge and rename generatedocbook/generatepot
The tool scripts used common functions, merge them to a single file
with different entry points.

Cleanup the merged file so that it passes the pep8 test.

Install the commands now as openstack-generate-docbook and
openstack-generate-pot. Leave a compatibility wrapper which should be
removed in version 0.8.

Change-Id: I7e4d651c4c62df58499e64e38528cb2cc4e9175b
2014-02-12 20:28:11 +01:00
Andreas Jaeger
2943a37fc7 Do not install internal scripts in /usr/bin
build-ha-guide.sh and markdown-docbook.sh are only needed by doctest.py,
so make them only available to that tool. There's no need to install
these files in /usr/bin.

Change-Id: Idd2f40dbe0a50a0936311574a26553444a4dd7e1
2014-02-11 22:39:09 +01:00
Sascha Peilicke
b08c80199f Honor install prefix
No need to put 'usr/' in front of data files, distros have the default
prefix set to '/usr' already such that 'setup.py install' does the right
thing. Compare with the results of 'python setup.py bdist'.

Change-Id: I8d7f592abece22f8bb70deede776509cdd1446e5
2014-02-06 11:34:45 +01:00
Andreas Jaeger
c586091172 Add tool to document cli tools
Call "os_doc_tools/commands.py" nova to generate a file
section_cli_nova_commands.xml with the command line options.

Allows generation of all supported clients with --all command.
The tool gets installed as: openstack-auto-commands

blueprint os-user-doc
Change-Id: Ie4b200818bd585d3fce0b27f0639ad03069b3b7b
2014-01-22 20:52:56 +01:00
Andreas Jaeger
b226f80820 Rename autogenerate-config-docs to autogenerate_config_docs
Minus signs are not allowed in python package names, thus rename the
directory.

Change-Id: Ie4b7cdff301673fdc0afe49c5b7211ee003871e5
2014-01-21 17:00:22 +01:00
Andreas Jaeger
93be0e5e62 Use sphinx for documentation of openstack-doc-tools
Update for using sphinx package so that documentation
follows the OpenStack python packaging conventions.

This contains an initial man page for the openstack-doc-test
tool.

Change-Id: I8b8ed63c3c7bcfb58f5d8f939a79c3f7c314b969
2014-01-03 12:19:40 +01:00
Andreas Jaeger
371fd80a7a Version handling
Add new parameter --version
pbr uses version number from git (via tags), so remove our own
version number. Once we tag a version "0.1", this will be the
version number.

Change-Id: Idcf9e4ddeebf637eb36797afd2855d1c657e52ea
2014-01-01 17:33:55 +01:00
Andreas Jaeger
45e80e4fef Package markdown-docbook.sh
Add markdown-docbook.sh to the python package

Change-Id: I678abe35583269b02ce6fbcddbe7eed98434388e
2013-12-28 16:08:44 +01:00
Andreas Jaeger
05f9428303 Rework repository to make it an installable python package
This is an overhaul of the complete content to make it
a separate python package that can be installed on the jenkins
machines as well as on editor's machines.

The goal of this patchset is to package everything
and get the command "openstack-doc-test" running so that
it can be used for gating.

This will need further refinement for the other commands.

Change-Id: Icc2f1807dd5ab5fb2f83c05d1b3895b3a9a0dbaf
2013-12-14 22:53:18 +01:00