diff --git a/autogenerate-config-docs/.gitignore b/autogenerate_config_docs/.gitignore similarity index 100% rename from autogenerate-config-docs/.gitignore rename to autogenerate_config_docs/.gitignore diff --git a/autogenerate-config-docs/README.md b/autogenerate_config_docs/README.md similarity index 91% rename from autogenerate-config-docs/README.md rename to autogenerate_config_docs/README.md index 82d11ab6..77f7dbdb 100644 --- a/autogenerate-config-docs/README.md +++ b/autogenerate_config_docs/README.md @@ -1,4 +1,4 @@ -autogenerate-config-docs +autogenerate_config_docs ======================== Automatically generate configuration tables to document OpenStack. @@ -63,12 +63,12 @@ This tool is divided into three parts: 1) Extraction of flags names - $ openstack-doc-tools/autogenerate-config-docs/autohelp.py create nova -i /repos/nova + $ openstack-doc-tools/autogenerate_config_docs/autohelp.py create nova -i /repos/nova You only need to use the `create` action to add a new product. Otherwise, use `update`. - $ openstack-doc-tools/autogenerate-config-docs/autohelp.py update nova -i /repos/nova + $ openstack-doc-tools/autogenerate_config_docs/autohelp.py update nova -i /repos/nova The `create` action will create a new `nova.flagmappings` file, possibly overriding an existing file. The `update` action will @@ -92,7 +92,7 @@ a category after a space. 3) Creation of docbook-formatted configuration table files - $ openstack-doc-tools/autogenerate-config-docs/autohelp.py docbook nova -i /repos/nova + $ openstack-doc-tools/autogenerate_config_docs/autohelp.py docbook nova -i /repos/nova Duplicate options @@ -135,12 +135,12 @@ This missed some requirements for nova, which were fixed by: Making the flag names update - $ ../../openstack-doc-tools/autogenerate-config/autohelp.py -vvv update nova -i ~/nova > nova.log + $ ../../openstack-doc-tools/autogenerate_config_docs/autohelp.py -vvv update nova -i ~/nova > nova.log At this point, search through nova.flagmappings.new for anything labelled Unknown and fix, once that is done use: - $ ../../openstack-doc-tools/autogenerate-config/autohelp.py -vvv docbook nova -i ~/nova + $ ../../openstack-doc-tools/autogenerate_config_docs/autohelp.py -vvv docbook nova -i ~/nova to generate the XML files and move those into the appropriate part of the git repo diff --git a/autogenerate-config-docs/__init__.py b/autogenerate_config_docs/__init__.py similarity index 100% rename from autogenerate-config-docs/__init__.py rename to autogenerate_config_docs/__init__.py diff --git a/autogenerate-config-docs/autohelp.py b/autogenerate_config_docs/autohelp.py similarity index 100% rename from autogenerate-config-docs/autohelp.py rename to autogenerate_config_docs/autohelp.py diff --git a/autogenerate-config-docs/common.py b/autogenerate_config_docs/common.py similarity index 100% rename from autogenerate-config-docs/common.py rename to autogenerate_config_docs/common.py diff --git a/autogenerate-config-docs/extract_swift_flags.py b/autogenerate_config_docs/extract_swift_flags.py similarity index 100% rename from autogenerate-config-docs/extract_swift_flags.py rename to autogenerate_config_docs/extract_swift_flags.py diff --git a/autogenerate-config-docs/flow.dia b/autogenerate_config_docs/flow.dia similarity index 100% rename from autogenerate-config-docs/flow.dia rename to autogenerate_config_docs/flow.dia diff --git a/autogenerate-config-docs/test/README.md b/autogenerate_config_docs/test/README.md similarity index 100% rename from autogenerate-config-docs/test/README.md rename to autogenerate_config_docs/test/README.md diff --git a/autogenerate-config-docs/test/genconfs.sh b/autogenerate_config_docs/test/genconfs.sh similarity index 100% rename from autogenerate-config-docs/test/genconfs.sh rename to autogenerate_config_docs/test/genconfs.sh diff --git a/autogenerate-config-docs/test/generator.py b/autogenerate_config_docs/test/generator.py similarity index 100% rename from autogenerate-config-docs/test/generator.py rename to autogenerate_config_docs/test/generator.py diff --git a/setup.cfg b/setup.cfg index ae5e3911..fcef84ce 100644 --- a/setup.cfg +++ b/setup.cfg @@ -20,7 +20,7 @@ classifier = [files] packages = os_doc_tools - autogenerate-config-docs + autogenerate_config_docs scripts = bin/build-ha-guide.sh bin/generatedocbook @@ -37,7 +37,7 @@ setup-hooks = [entry_points] console_scripts = openstack-doc-test = os_doc_tools.doctest:main - openstack-autohelp = autohelp:main + openstack-autohelp = autogenerate_config_docs.autohelp:main [build_sphinx] source-dir = doc/source diff --git a/tox.ini b/tox.ini index f81e5fcc..5e777344 100644 --- a/tox.ini +++ b/tox.ini @@ -24,7 +24,6 @@ commands = {posargs} [flake8] # H803 skipped on purpose per list discussion. # E123, E125 skipped as they are invalid PEP-8. -# autogenerate-config-tools skipped until it passes all tests show-source = True ignore = E123,E125,H803