The oslo sphinxconfiggen module was added to the oslo.config
2.3.0 release. This enables config file generation as part of
the sphinx doc generation.
The generated config file will pick up the current config
options from the code base. And as an added bonus, it will
now be published to the docs.openstack.org site for easy
reference or download.
This also puts us inline with what other projects like Nova
are doing for sample config files and is the recommended
method from the Oslo team.
Change-Id: I912a97eb2686d3dc56e50d8641d7bd930179bc18
This patch is for converting API Reference to RST and host it
in the Cinder tree.
This patch contains all the RST for cinder to bring over to their
repos to begin building API reference information from within.
This contains .inc files which have all the contents of the .rst files
but are grouped together for easier editing
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API.
Cleaning task will be done once this part is merged.
As we have removed XML API support in Newton release, we need to
remove XML from API reference as well.
But we still have installations which are using XML.
So implementation plan is to first merge this patch in Newton release
keeping XML for now, then I will backport same to stable branches.
After that I will remove same from Newton release to match API
reference with actual API implementation.
Implements: bp api-reference-to-rst
Change-Id: I865ac922538bfa5bd45c24eb4bc49f5e966dc811
Now that we have some sort of conf checking again in the
tox ini file, we should make sure we don't inadvertenly
commit a generated sample (which I've done twice now).
Change-Id: I51124971ee52a1caf48123c5c2df2759bbcc045d
Ignore all dotfiles in the base dir of the tree except for
.gitignore, .coveragerc, .mailmap, and .testr.conf.
This should solve the "ignore my IDE's files" problem in a
general way.
Change-Id: Ia53fff4b97e4e99b6827030573973377beddb22b
To ignore swap files from getting into repository
currently the implemented ignore is *.swp
however vim adds more swap files if .swp exists,
so improving this with .*.sw?
Closes-Bug: #1255857
Change-Id: I22b6fa351dd565d4783f432c01785c706acd8397
Like some of the other projects (nova, heat, oslo) git ignore eclipse
project files. This will remove manual steps for people developing from
eclipse.
Change-Id: Ib908c8d419072b440f5ec647bea8f13b97e48f7c
lintstack is a pylint-based static analysis tool to find bugs
in Python code.
To run the test via tox: $ tox -e pylint
To run the test directly: $ tools/lintstack.sh
Change-Id: If155f47ed84eb820ac505ee741bdd18edd41b1eb
