14 Commits

Author SHA1 Message Date
Steve Baker
44cc6dd792 Add wsme core types, remove WSME
The header for the file types.py denotes its dual-licensed status as
MIT with copyright to the original WSME authors, plus apache licensed
as part of Ironic.

Story: 1651346
Task: 10551

Change-Id: I986cc4a936c8679e932463ff3c91d1876a713196
2020-07-14 10:34:13 +12:00
Andreas Jaeger
a2efd0b82a Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* parallelizing building of documents

Update Sphinx version as well.

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.

Set openstackdocs_pdf_link to link to PDF file.
Set openstackdocs_auto_name to use 'project' as name.

Depends-On: https://review.opendev.org/728938
Change-Id: I76a21521eeb432c3f4089048a4635719ba6d785c
2020-05-18 19:34:17 +02:00
Dmitry Tantsur
ce878131cd Remove testscenarios, testrepository and Babel from test-requirements
Neither of these are really used. They have likely been cargo-culted.

Also removing mock from doc/requirements, not sure how it got there.

Change-Id: I8d242d86af4c6ded215e0bc4cf61da346f21e46c
2020-05-05 11:01:59 +02:00
Andreas Jaeger
163c8346a3 Cleanup Python 2.7 support
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove section from setup.cfg: Wheel is not needed for python
  3 only repo
- Update requirements, no need for python_version anymore

Change-Id: Ib2221fc13cd53c93150e838418e7e110e087d1b3
2020-04-03 17:49:23 +02:00
Andreas Jaeger
5cebea361b Cleanup docs building
* Remove doc/source/install/conf.py, it's unused.
* Remove settings that are provided by openstackdocstheme from conf.py
  files. Switch to newer openstackdocstheme for this.
* Remove unused deps from tox.ini: releasenotes and api-refonly need
  doc/requirements but not requirements.

Change-Id: Iab5ad6cde40c3342770c0112155fe5e1d262d1e8
2020-02-29 15:12:04 +01:00
Iury Gregory Melo Ferreira
b869b46c63 Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

Ironic 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: I3cc36d79ffabf31607d503dada9e7512c639647c
2019-11-22 14:06:45 +01:00
Kaifeng Wang
9aab525d45 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: Icf1e4b58675b23e82ee6f6d79eb8852436ed55bb
2019-09-06 14:50:02 +08:00
翟小君
1becd6dda9 Bump openstackdocstheme to 1.20.0
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: I308c3296bc56fdb623a9fc6b021c388be2d33330
2019-07-02 10:18:03 +08:00
pengyuesheng
7eba36e74b Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details
Depend-On: https://review.opendev.org/#/c/663060/

Change-Id: Id7033122874f1ebbe1b659fae854b21003e5c0e1
2019-06-21 11:03:52 +08:00
Ilya Etingof
234dea98bb Bump lower mock version to 3.0.0
Previously used mock 2.0.0 has a nasty bug which prevents mocking
`@staticmethod` callables [1][2].

1. https://github.com/testing-cabal/mock/blob/master/CHANGELOG.rst#300
2. https://bugs.python.org/issue23078

Change-Id: I38d78cb8de92e9ecfc3dda5ffafcb4ffe175169e
2019-06-04 17:05:01 +02:00
Riccardo Pittau
9ed9101394 Update sphinx requirements
Following recent changes to global requirements [1], we need
to update sphinx requirements locally.

[1] If558f184c959e4b63b56dec3ca1571d1034cfe5c

Change-Id: Ia0dd6883b4c15b8a0646ee765689343c116b2bcd
2019-05-22 15:03:52 +02:00
Jan Gutter
d52aacd29d Bump sphinxcontrib-pecanwsme to 0.10.0
Sphinx 2.0 requires at least 0.10.0

Depends-on: I50f778e639acd2b4d9b0069a0081ff78b574ba7c
Change-Id: If88c529a60b0a58eb9439af1115ab558b6d7f6dd
Signed-off-by: Jan Gutter <jan.gutter@netronome.com>
2019-04-02 14:52:39 +02:00
Julia Kreger
146bbb48cc Add mock to doc requirements to fix doc build
Change-Id: Id614d383c2e1b8736399d03df8cea3d05b7e6975
Story: #2002135
Task: #19823
2018-05-31 13:36:30 -07:00
Nguyen Hai
7ba42e091d Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

[doc/requirements.txt] & [test-requirements.txt]
To support documentation generation in new PTI, project should have
list python dependencies needed for documentation in
doc/requirements.txt which are move from test-requirements.txt

[doc/source/contributor/index.rst] & [setup.cfg]
- Remove [pbr] section in setup.cfg [3], and unrelated lines in
contributor/index.rst
[3] http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html
- Add sphinxcontrib.apidoc to replace pbr autodoc

[tox.ini]
--ignore D000: pep8 require sphinx (which move to doc/requirements.txt)
to test doc/source files, however, docs already test the doc/source.
Therefore we can ignore the D000 error code.

Depends-On: https://review.openstack.org/#/c/559327/
Change-Id: Iee90f19a5e46978a97035eab7e4b1e0ec68b8684
2018-04-06 14:33:47 +00:00