1. Clean up the unnecessary sphinx from test-requirements.txt
2. when run `tox -e docs` in localhost, some files will be
created, it not belong to the code, shoule be ignore by the git
Change-Id: I2bae30fedfdc64fbbafbe0e96794597b564c2d54
Since we have migrate test to stestr we can remove testrepository
from imports and stop to ignore him.
Change-Id: I74a24f19268d39dbce42963c95a9f06ca9b3f014
os-testr has moved over to use stestr instead of testr. While this
is usually compaible with existing settings, there is a warning
that is emitted when .stestr.conf is not present. It is usually
able to fall back to parsing the .testr.conf file, but to be more
correct and to prevent future problems we should update the config.
Change-Id: I929f75d069f20b8cfa8af4e0712883e91a54dc4f
Developers run all sorts of different tools within Git repositories,
any of which can leave their own special trashfiles all over the
place. We can't every hope to catalog them all, so better to
recommend developers simply configure a global core.excludesfile to
filter the irrelevant files which tend to get created by their
personal choice of tools.
To this end, remove the long-standing sections for "Mr Developer"
and "Editors" since their mere existence here sends the signal that
we welcome (and have time to review) additions for any old tool
someone ever might happen to try. Also add a comment block
explaining this, for clarity.
We can, and should of course, continue to list files created by the
tools recommended by our workflow (test frameworks called from tox,
documentation and packaging builds, et cetera).
This change is a port of I1b41efac219fca44e2548fc36633724d0ecfc0cb
from the openstack-dev/oslo-cookiecutter repository.
Change-Id: I5baba0f92e4272ba7e28f22ab6264651794ebf50
I'm seeing a bunch of .coverage.openstack.novalocal.29039.104933
files in my source directory after running unit tests.
Change-Id: I354c6a7e47d9267a48f117e1c7f73fcd9e7cc1fb
The release management team have indicated this is their preferred way
to collect release notes in future.
Change-Id: Icab591ed1b12c1fd84c15f7b4a5d1d56d1d7588a
This commit adds a sphinx extension which can be loaded in a sphinx
config.py to generate a sample config file using oslo-config-generator
during each sphinx build. This can then be incorporated into
documentation as necessary.
Co-Authored-By: Doug Hellmann <doug@doughellmann.com>
Change-Id: I2561155749fc8c6a8e31df1614ca6cdb50b4c001
Move the public API out of oslo.config to oslo_config. Retain the ability
to import from the old namespace package for backwards compatibility
for this release cycle.
bp/drop-namespace-packages
Change-Id: I56274336802036de050efc62eb2ee6b5d4ede77b
Like some of the other projects (nova, heat) ignore eclipse
project files, for those people that work with eclipse (yuck :)
Change-Id: I803a5a9a4bf30dc053b3f3a260a69ce19f3a6c9b
Add basic sphinx config and copy the theming from oslo-incubator which
was originally copied from keystone.
Change-Id: Ibb3b679ce6e160c157ff63f0943807bd82aa1a67