Remove obsolete doc-test.conf
With openstack-doc-tools 1.0.0, this file is not used anymore, remove it. Also, remove all mention of openstack-doc-test, this tool is not anymore part of openstack-doc-tools. Change-Id: I3bebcb269f1ff067e2ba591dd9e3d8f47d31d306
This commit is contained in:
Andreas Jaeger
parent
67af42095b
commit
a399e06ec4
|
|
@ -1,11 +0,0 @@
|
|||
[DEFAULT]
|
||||
repo_name = openstack-manuals
|
||||
|
||||
# Publish to /draft instead of /trunk
|
||||
release_path = draft
|
||||
|
||||
url_exception = https://build.opensuse.org/package/show?package=python-pip&project=Cloud:OpenStack:Master
|
||||
url_exception = https://packer.io
|
||||
|
||||
# The following imported files should not be checked.
|
||||
file_exception = dashboard-nova_policy.json
|
||||
|
|
@ -18,7 +18,5 @@ location, explains how to install, configure, use, and contribute to them.
|
|||
|
||||
doc-tools/scripts.rst
|
||||
doc-tools/installation.rst
|
||||
doc-tools/configuration.rst
|
||||
doc-tools/cli-reference.rst
|
||||
doc-tools/openstack-doc-test.rst
|
||||
doc-tools/contributing.rst
|
||||
|
|
|
|||
|
|
@ -1,66 +0,0 @@
|
|||
=======================================
|
||||
Configure OpenStack documentation tools
|
||||
=======================================
|
||||
|
||||
OpenStack documentation tools use the ``doc-test.conf`` file as a source for
|
||||
the default settings.
|
||||
|
||||
By default, the :command:`openstack-doc-test --check-build` copies the books
|
||||
to the ``publish-docs`` directory in the top-level directory of a project's
|
||||
repository. You can modify the default settings for the books that require
|
||||
special treatment by configuring the following options:
|
||||
|
||||
book
|
||||
The name of a book that needs special treatment
|
||||
|
||||
target_dir
|
||||
The path of subdirectory starting at ``target`` that is the root for
|
||||
publishing
|
||||
|
||||
publish_dir
|
||||
A new name to publish a book under
|
||||
|
||||
.. note::
|
||||
|
||||
You can specify these options multiple times and should always use them
|
||||
this way.
|
||||
|
||||
You do not need to set ``publish_dir`` but if you set it, you need to use
|
||||
it every time.
|
||||
|
||||
As an example, to publish the compute-api version 2 to
|
||||
``publish-docs/api/openstack-compute/2``, edit ``doc-test.conf`` as follows:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
book = openstack-compute-api-2
|
||||
target_dir = target/docbkx/webhelp/api/openstack-compute/2
|
||||
publish_dir = api/openstack-compute/2
|
||||
|
||||
|
||||
Sample doc-test.conf file
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
[DEFAULT]
|
||||
|
||||
repo_name = openstack-doc-tools
|
||||
api_site=True
|
||||
|
||||
# From api-ref/src/wadls/object-api/src/
|
||||
file_exception=os-object-api-1.0.wadl
|
||||
|
||||
ignore_dir=incubation
|
||||
ignore_dir=openstack-compute-api-1.0
|
||||
|
||||
# These two (or three) options need to come as pairs/triplets.
|
||||
# Either add publish_pair for each book/target_dir pair or not at all.
|
||||
# If publish_dir is not specified, book is used as publish_dir.
|
||||
book = api-quick-start
|
||||
target_dir = target/docbkx/webhelp/api-quick-start-onepager-external
|
||||
#publish_dir = api-quick-start
|
||||
|
||||
book = api-ref
|
||||
target_dir = target/docbkx/html
|
||||
#publish_dir = api-ref
|
||||
|
|
@ -22,19 +22,6 @@ the following steps:
|
|||
For now, the documentation toolkit is tested with basic ``flake8``
|
||||
and ``bashate`` tests. A test suite would be welcome.
|
||||
|
||||
Since the ``openstack-doc-test`` tool is used for gating of
|
||||
the OpenStack documentation repositories, test building of
|
||||
these repositories with any changes done within the tool repository:
|
||||
|
||||
#. Install ``openstack-doc-tools`` locally.
|
||||
#. Check out the gated repositories.
|
||||
The repositories gated by ``openstack-doc-tools`` are:
|
||||
|
||||
* api-site
|
||||
* openstack-manuals
|
||||
|
||||
#. Run :command:`tox` inside of each gated repository.
|
||||
|
||||
#. Submit your change for review through the Gerrit tool as described
|
||||
in the `gerrit workflow <http://docs.openstack.org/infra/manual/developers.html#development-workflow>`_.
|
||||
|
||||
|
|
@ -52,6 +39,6 @@ the following steps:
|
|||
File a bug against the tools
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you experience an issue while using the ``openstack-doc-test`` tool,
|
||||
If you experience an issue while using the tools,
|
||||
file a bug on Launchpad in the `openstack-manuals project
|
||||
<https://bugs.launchpad.net/openstack-manuals>`_, not on GitHub.
|
||||
|
|
|
|||
|
|
@ -1,89 +0,0 @@
|
|||
.. _openstack-doc-test:
|
||||
|
||||
========================================
|
||||
Validate OpenStack documentation content
|
||||
========================================
|
||||
|
||||
To test the validity of the OpenStack documentation content, use
|
||||
the :command:`openstack-doc-test [options]` command with the following
|
||||
available options:
|
||||
|
||||
.. note::
|
||||
|
||||
For option processing, the ``openstack-doc-test`` tool reads
|
||||
the `doc-test.conf` in the top-level directory of the git repository.
|
||||
|
||||
--api-site
|
||||
Special handling for api-site and other API repositories
|
||||
to handle WADL.
|
||||
|
||||
--build-file-exception BUILD_FILE_EXCEPTION
|
||||
File that will be skipped during delete and build checks to
|
||||
generate dependencies. This should be done for invalid XML files only.
|
||||
|
||||
--check-build
|
||||
Try to build books using modified files.
|
||||
|
||||
--check-deletions
|
||||
Check that deleted files are not used.
|
||||
|
||||
--check-links
|
||||
Check that linked URLs are valid and reachable.
|
||||
|
||||
--check-niceness
|
||||
Check the niceness of files, for example whitespace.
|
||||
|
||||
--check-syntax
|
||||
Check the syntax of modified files.
|
||||
|
||||
--check-all
|
||||
Run all checks (default if no arguments are given).
|
||||
|
||||
--config-file PATH
|
||||
Path to a config file to use. Multiple config files can be
|
||||
specified, with values in later files taking precedence.
|
||||
|
||||
--debug
|
||||
Enable debug code.
|
||||
|
||||
--file-exception FILE_EXCEPTION
|
||||
File that will be skipped during niceness and syntax validation.
|
||||
|
||||
--force
|
||||
Force the validation of all files and build all books.
|
||||
|
||||
-h, --help
|
||||
Show help message and exit.
|
||||
|
||||
--ignore-dir IGNORE_DIR
|
||||
Directory to ignore for building of manuals. The parameter can
|
||||
be passed multiple times to add several directories.
|
||||
|
||||
--language LANGUAGE, -l LANGUAGE
|
||||
Build translated manual for language in path generate/$LANGUAGE .
|
||||
|
||||
--only-book ONLY_BOOK
|
||||
Build each specified manual.
|
||||
|
||||
--parallel
|
||||
Build books in parallel (default).
|
||||
|
||||
--print-unused-files
|
||||
Print list of files that are not included anywhere as part of
|
||||
check-build.
|
||||
|
||||
--publish
|
||||
Setup content in publish-docs directory for publishing to
|
||||
external website.
|
||||
|
||||
--verbose
|
||||
Verbose execution.
|
||||
|
||||
--version
|
||||
Output version number.
|
||||
|
||||
Building of books generates the following output in the top-level directory
|
||||
of the repository:
|
||||
|
||||
* The ``publish-docs`` directory with a copy of the build results.
|
||||
* A log file for each book named ``build-${book}.log.gz``.
|
||||
|
|
@ -29,10 +29,6 @@ bin
|
|||
os_doc_tools directory
|
||||
----------------------
|
||||
|
||||
openstack-doc-test
|
||||
Checks niceness of the documentation. Tests links, whitespace, line-endings.
|
||||
See :ref:`openstack-doc-test`.
|
||||
|
||||
openstack-autohelp
|
||||
A helper script run from the git repository by ``autogenerate_config_docs``.
|
||||
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ mkdir -p publish-docs
|
|||
# Build all RST guides
|
||||
tools/build-all-rst.sh
|
||||
|
||||
# Build the www pages so that openstack-doc-test creates a link to
|
||||
# Build the www pages so that openstack-indexpage creates a link to
|
||||
# www/www-index.html.
|
||||
if [ "$PUBLISH" = "build" ] ; then
|
||||
python tools/www-generator.py --source-directory www/ \
|
||||
|
|
|
|||
Loading…
Reference in New Issue