84f8c3095a
This patch fixes all sphinx warnings generated by malformed docstrings. Additionally, it contains formatting and accuracy fixes for the metrics docstrings, to ensure blockquotes are properly rendered, and to indicate the get_metrics_logger() method is actually in metrics_utils. Finally, this adds doc8 to the pep8 job, ensuring we don't reintroduce some of these errors. As a note, there are items that can cause warnings in doc builds that aren't enforced by doc8, and can't be enforced until a doc build job is added to project-config. Change-Id: I622812bfe8af576ab215c098dd211c6faf697a0c Partial-bug: #1614272 Partial-bug: #1611559 |
||
|---|---|---|
| doc/source | ||
| etc/rootwrap.d | ||
| ironic_lib | ||
| .gitignore | ||
| .gitreview | ||
| .testr.conf | ||
| CONTRIBUTING.rst | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.rst | ||
| TESTING.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
README.rst
ironic_lib
Overview
A common library to be used exclusively by projects under the Ironic governance.
Running Tests
To run tests in virtualenvs (preferred):
sudo pip install tox
toxTo run tests in the current environment:
sudo pip install -r requirements.txt
nosetests