openstack-doc-tools/releasenotes/notes/the-great-doc-tools-cleanup-1a79e2c200232489.yaml
Stephen Finucane ca9ff17d27 Remove "cleanup" tools
There were a couple of scripts here:

- prettify.py
- remove_trailing_whitespaces.sh
- remove_unnecessary_spaces.py
- retf

Most of them are self-explanatory with the exception of 'retf', which I
don't understand but which looks untouched in years and therefore
useless. For the other three, we have tooling in place to ensure these
"issues" don't get into source control and, even if they did, there's
questionable value in rewriting stuff just to remove excess whitespace.
Kill them all.

Change-Id: Ifbd2d50a669251484056552da21d23906f8d6178
2017-10-04 11:48:00 +01:00

26 lines
984 B
YAML

---
upgrade:
- |
The `autogenerate_config_docs` set of tools has been removed. These were
always buggy and hard to maintain, and they have been superseded by the
``oslo_config.sphinxext`` `Sphinx extension`__.
__ https://docs.openstack.org/oslo.config/latest/reference/sphinxext.html
- |
The ``openstack-auto-commands`` command and its helper script in
``bin/doc-tools-update-cli-reference`` have been removed. These have been
superseded by the ``cliff.sphinxext`` `Sphinx extensions`__.
__ https://docs.openstack.org/cliff/latest/user/sphinxext.html
- |
The following scripts and tools have been removed:
- prettify.py$
- remove_trailing_whitespaces.sh$
- remove_unnecessary_spaces.py$
- retf$
These were all indented to cleanup docs once they were already in tree, but
our tooling and review process should be sufficient to catch most issues
and there's limited value in submitting whitespace-fixup patches.