Browse Source

Rename autogenerate-config-docs to autogenerate_config_docs

Minus signs are not allowed in python package names, thus rename the
directory.

Change-Id: Ie4b7cdff301673fdc0afe49c5b7211ee003871e5
changes/53/68153/1
Andreas Jaeger 8 years ago
parent
commit
b226f80820
  1. 0
      autogenerate_config_docs/.gitignore
  2. 12
      autogenerate_config_docs/README.md
  3. 0
      autogenerate_config_docs/__init__.py
  4. 0
      autogenerate_config_docs/autohelp.py
  5. 0
      autogenerate_config_docs/common.py
  6. 0
      autogenerate_config_docs/extract_swift_flags.py
  7. 0
      autogenerate_config_docs/flow.dia
  8. 0
      autogenerate_config_docs/test/README.md
  9. 0
      autogenerate_config_docs/test/genconfs.sh
  10. 0
      autogenerate_config_docs/test/generator.py
  11. 4
      setup.cfg
  12. 1
      tox.ini

0
autogenerate-config-docs/.gitignore → autogenerate_config_docs/.gitignore

12
autogenerate-config-docs/README.md → 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

0
autogenerate-config-docs/__init__.py → autogenerate_config_docs/__init__.py

0
autogenerate-config-docs/autohelp.py → autogenerate_config_docs/autohelp.py

0
autogenerate-config-docs/common.py → autogenerate_config_docs/common.py

0
autogenerate-config-docs/extract_swift_flags.py → autogenerate_config_docs/extract_swift_flags.py

0
autogenerate-config-docs/flow.dia → autogenerate_config_docs/flow.dia

0
autogenerate-config-docs/test/README.md → autogenerate_config_docs/test/README.md

0
autogenerate-config-docs/test/genconfs.sh → autogenerate_config_docs/test/genconfs.sh

0
autogenerate-config-docs/test/generator.py → autogenerate_config_docs/test/generator.py

4
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

1
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

Loading…
Cancel
Save