Commit Graph

13 Commits

Author SHA1 Message Date
Riccardo Pittau 55972ab6fb Reconfigure tox.ini
Update minversion of tox to 3.9.0 to support inline comments [1]

Remove test-requirements and move pep8 requirements to tox.ini

[1] https://tox.readthedocs.io/en/latest/changelog.html#v3-9-0-2019-04-17

Change-Id: I5875b1ab383fef4bc49432e678e38941a7f5763e
2021-01-23 18:52:04 +01:00
Iury Gregory Melo Ferreira dc090b273a Add doc/requirements
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver for the release team.
Removed specific doc requirements from test-requirements.txt

Change-Id: Ibeb6253046787a7a0768879067facaaeb0137cdb
2021-01-06 15:46:09 +01:00
Riccardo Pittau 36a91b78ea Set safe version of hacking
Versions of hacking from 3.1.0 until 4.0.0 NOT included are supposed
to require a safe version of flake8, so besides normale issues related
to minor version upgrades, we can safely use those versions.
Also forcing pycodestyle versions to be compatible with flake8 installed
by hacking.

Change-Id: If790ffa7980f90426ec91e2bd2d862541ecbc061
2020-10-19 13:47:22 +00:00
Andreas Jaeger 16a734a0ea Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 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.

Disable openstackdocs_auto_name to use 'project' variable 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.

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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Idbe930500bc7988d7e1d78cff3f39beae775db89
2020-05-21 13:47:58 +00:00
Riccardo Pittau dd90f32dfe Upgrade flake8-import-order version to 0.17.1
Full py3 compatible version.
Add all Python3 modules to stdlib list.
Also includes fix to an enum34 dependency bug.

Change-Id: I5eda08276c267c0866067bad1daa73513019b9b6
2020-04-21 16:08:55 +02:00
Andreas Jaeger 9fddc46bdc Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
- Update hacking to version 3

Change-Id: I7e9e3993aeb05fb623be531160e418572fa9de54
2020-04-16 18:52:41 +02:00
Madhuri Kumari 55aaf172b1 Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

ironic-python-agent-builder is ready with python 3 and ok to drop
the python 2.7 support.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal - https://review.opendev.org/#/c/691178/

Change-Id: I4dc5fe4cbb2ec4e604e18f77da4b5723ab7f9c2b
2019-11-23 18:39:21 +05:30
pengyuesheng cb9f2a0fef Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: Ie33a627ce346bb1aa174963dbf7f4a8f8308ad04
2019-10-09 16:23:43 +08:00
Zuul 7e1581bc06 Merge "Build pdf doc" 2019-09-09 14:42:50 +00:00
Kaifeng Wang cea462b0e4 Build pdf doc
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

Change-Id: Ic036194e33224be9341dbde901c4ba4717ccbbc8
2019-09-05 14:31:51 +08:00
Dmitry Tantsur c56bffbefe Make ironic-python-agent-builder packaging-friendly
* Install dib files to /usr/share (tinyipa TBD later)
* Add an executable that can be installed into /usr/bin

Since we now have python code, make pep8 operational.

Change-Id: I9235885485833c4011e42da6db01e150821bd8da
2019-08-12 15:28:34 +02:00
Riccardo Pittau 5c6ce6d77d Update sphinx requirements
Following recent changes to global requirements [1], we need
to update sphinx requirements locally.

[1] If558f184c959e4b63b56dec3ca1571d1034cfe5c

Change-Id: I68b94efdcb2a10d95afe4ef43b1fc6b236e525a3
2019-05-23 10:35:49 +02:00
Dmitry Tantsur 77c8f45838 Initial structure
Change-Id: If014272a204953da387855e2666f01d4e9229eaa
2017-11-03 14:34:47 +01:00