This is the first in a series of commits to add support for codespell. This is continuning the process completed in ironic-python-agent.
Future Commits will add a Tox Target, CI support and potentially a git-blame-ignore-revs file if their are lots of spelling mistakes that could clutter git blame.
Change-Id: I1efadb54995b0f5a2a8b672f017831a3009cb6d2
* Remove .testr.conf as it's not used anywhere
* Remove .testrepository from .gitignore
* Use 3.18.0 as the minversion for tox
* Add 17.1.0 as lower bound for 'horizon' package in
doc/requirements.txt
Signed-off-by: HeroicHitesh <email.hiteshkumar@gmail.com>
Change-Id: I19741f36d0bd08e49faa5be222adce9eb61b41a5
The mock third party library was needed for mock support in py2
runtimes. Since we now only support py36 and later, we don't need it
in lower-constraints and requirements.
These changes will help us to drop `mock` from openstack/requirements
Change-Id: Ia3b71f68ba1714b7b7254119c1b610b1390f7059
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Set openstackdocs_auto_name to use 'project' as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I497fa0cbaedba4be199a7bd0dc86f686c0858ac0
Seems somewhere along the line the install
formatting got mangled.
Fixes formatting. Also fixes the gitignore
for the python api doc folder.
Story: #1737898
Task: #11683
Change-Id: I1b8848c5703ab3d6434d47138c11309bdd83b2cd
With the updated docs build job, doc building is failing since
DJANGO_SETTINGS_MODULE is not set. Define it properly.
Change-Id: Idc43f59bf6d04705a30c02fd316f50706aacd4ef
In addition to adding that configuration,
a portion of the documentation conf.py file
needed to be updated from the horizon panel
cookiecutter repository.
Change-Id: I39b1d8718b1de51093a10f50dd04a5ff1d75dd46
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: I560d46158edf98eb64ab524fc6af77cf95c6c1bc
In contributing doc, some links and informations are still for
ironic, we should change to use ironic-ui.
Change-Id: If75b79927e9cbb269057dc5311ef8f5ccc6a1f32
Warnings, such as those caused by the README.rst file's
inclusion of an externally hosted file cause the default
sphinx job to fail. Removed the link, and cleaned up the
documentation formatting to make it more clear moving
forward.
Change-Id: I55afe786b794a6cb179a3de20b5f4e0f3f8072c8
Updated developer documentation to include introduction to the
ironic-ui and links to other relevant docs.
Change-Id: I82086e0c9e8011cfcaa13d4057ab2f828c1c0515
In patch amends have also renamed internal ironic-ui folder to ironic_ui to
ensure not read mathematically to pass pep8 tests. Also added global requirements.
Change-Id: I5689f762194291bbad6070350486d397c376364a
Sharpz7