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
Remove some warnings noticed by pylint.
There're still a lot of warnings, this is just an iterative improvement.
Change-Id: Iafecf55176f230b91353ecd5b5014ba749056f89
* E129 visually indented line with same indent as next logical line
* E129 visually indented line with same indent as next logical line
* E265 block comment should start with '# '
* E713 test for membership should be 'not in'
Change-Id: I8488f7ad4399153d99325806fe87919c0b4cda7e
* E265 block comment should start with '# '
* E101 indentation contains mixed spaces and tabs
* W191 indentation contains tabs
* E126 continuation line over-indented for hanging indent
* W391 blank line at end of file
Also enabled doc/ to be checked by flake8 in tox.ini.
Change-Id: I6ef75ccffb94dd2df346e844d351ea477e560a42
The generatedocbook tool only works on XML files.
For the high-availability guide, we first need to generate the XML file
and then integrate translations - and take care that the build job not
regenerates the XML file.
Change-Id: Iab7a72d2819b4fc5d0bac53b8a9ccba2ba9ef0ef
- generate the tables in the doc/common/tables dir by default
- make the -i switch optional, and assume that git git repositories are
in a ./sources/ dir
- use elif's instead of multiple return statements in the subcommand
test
Change-Id: If96ac9df247cea5061c056328307ec88ab74a4f3
The common.py file is only used by autohelp.py, so is not really a
common file. Include its content in autohelp.py.
Also remove the unused _() definition.
Change-Id: I4e228637e3f6287fd2770ba386dd0fdba6977a81
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
Non-breaking space is often not visible in our tools, or shown as normal
space. We should use instead. Warn about non-breaking space like
we warn about tabs.
Change-Id: I1bbbb1f19c56d3cc1b949df151b41886a0c46042
Related-Bug: #1314498
Change way on how the screens are generated so that we really
have </screen> on the closing line.
Also, update swift usage line so that it is not inside a screen but in a
normal para.
Add new option --output-directory for defining the directory where the
files will be written to.
Change-Id: Ie5d039ad673290720993586bd137c51183afa822
The code for parsing existing tables didn't find all the options because
of spaces and new lines. This patch should now handle those characters.
Change-Id: If6a5d8812e6e6f46e14944578cc5eb94d8374ccf
The generatedocbook command only handled books in subdirectories of
./doc. This assumption only works for operations-guide and
openstack-manuals but not for the api-site. Add parameter --root to give
the root directory. For the api-site, this would be "--root ./".
Change-Id: I9f477239677ca5a32b19bd565f8a37288f7e869e
Find books that need to be rebuild for api-site better:
* Handle include of wadl resources.
* Handle file layout of api-site.
Add new option --print-unused-files.
Change-Id: I8ad61cf53728e3b5ba71077bf53b1780a2535c2e
These options are not directly imported in the projects, but instead
used as a middleware in the paste configuration. We force and import of
the middleware to discover the options.
Change-Id: I6e8a7abca63a86db9dd215c012b10ef2d89c18df
www is copied to publish-dir/www but this is not desired when publishing
for our external website - only for drafts.
Add option --publish for publishing to external website
that does not copy www over and also always builds manuals.
Change-Id: I9972a690c6c714fbe028b47ff1da2884d058282b
The oslo CLI options are defined using dashed, but should appear with
underscores in the tables (as in config files). Using the dest attribute
will fixed this problem.
Change-Id: I82d56ba6f62f840e757413f7c996b927fede107d
Autodiscovery has limits, and it seems easier to handle some special
cases than adding more complexity in the parsing code.
This patch provides a hook mechanism allowing to execute methods for
some modules.
Add a hook for keystone.common.config.
Change-Id: I6791afbebbc329a5731f0fcfa452c34baaa2905d
There's nothing introspectable in the projects or oslo.rootwrap, but all
projects that use rootwrap have a sample etc/($project/)?rootwrap.conf
file. This file is relatively simple to parse for allowed options and
comments. It's not the best solution, but it's a solution.
Closes-Bug: #1253690
Change-Id: I51973a4b8f0ac6ea047c4ffc07647a10bdea92ee
Do not publish wadls directories at all.
Do not publish .fo files.
Create in our docs-draft index.html file a list of the api-ref-guides
PDF files.
Update README.rst for 0.10 release.
Change-Id: I049456530431dd855395ca255b4f06c954720ae0
An older format of the flagmappings file required to handle options that
moved from a section to another. This older format is no longer used
and might genereate incorrect default values for new options in groups
other than DEFAULT. Remove the code to avoid this problem.
Change-Id: Iacd55a278f33c05cc6dffbbfedc2ceffedd6ad05