Commit Graph

11 Commits

Author SHA1 Message Date
Arnaud Morin c77a51a05a Fix doc builds
A new release of dnspython has been release, which is breaking the docs
tests. See [1]

dnspython is fixed to <2.3.0 in upper-constraints, so we should rely on
requirements.txt from mistral to trigger the correct build.

[1] https://github.com/eventlet/eventlet/issues/781

Signed-off-by: Arnaud Morin <arnaud.morin@ovhcloud.com>
Change-Id: I5f86f8264792c8e651c0bb2d2f63151657fea1be
2023-01-18 18:02:03 +01:00
Andreas Jaeger 4b52d4d458 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.

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.

Remove python 3 versioning from lower-constraints and
requirements to pass requirements-check.

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

Change-Id: Id478711abb1783422ebb4ee9937d1b7202fdf2f3
2020-05-21 15:50:23 +02:00
Renat Akhmerov 6fb17d8266 Add YAQL sanitizing for iterators
* This patch also adds handling for iterators in the sanitizing
  function for YAQL results. JSON serialization for iterators now
  works correctly but the issue is that they can be used only once.
  So, for example, if we got a result from YAQL and performed JSON
  serialization for it, then the iterator is already empty and
  the data structure is just corrupted. So we can't further pass
  to executors and other subsystems. The solution is just to sanitize
  iterators after they're just returned from YAQL.
* Added a test to make sure that action input reaches an executor
  not corrupted, although it gets saved into DB and hence serialized
  into JSON.
* Changed the Sphinx entry in requirements.txt so that the version
  3.0.0 is now excluded (it breaks the build).

Closes-Bug: #1871567
Change-Id: I47abe0904b49d72e33eb10080c71fb81980d44da
2020-04-08 15:44:13 +07:00
Eyal 8bdf341af7 Remove OpenStack actions from mistral
Depends-on: https://review.opendev.org/#/c/703296/
Depends-On: https://review.opendev.org/#/c/704280/
Change-Id: Id62fdabe7699e7c3b2977166e253cfc77779e467
2020-02-26 10:12:01 +02:00
Eyal 55f181f8aa Fix requirements remove py2
Change-Id: If18cd11db29a45f64666172674e1eb55b0a51d73
2020-01-15 16:17:26 +02:00
caoyuan 6e89218125 tox: Keeping going with docs
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: Ife98c47af59355540fa30d7ca762f857759c1274
2019-10-24 13:20:19 +00:00
Zuul e35407a6d6 Merge "Bump openstackdocstheme to 1.30.0" 2019-06-06 10:09:44 +00:00
翟小君 6dc981d814 Bump openstackdocstheme to 1.30.0
Some minor updates including fixing issues with the HTML5 output
generated by Sphinx 2.0, inlining the OpenStack logo rather than
referencing it from elsewhere, and adding a new SOURCE_DATE_EPOCH option
for use in reproducible builds in new release openstackdocstheme 1.30.0.
...to pick up many improvements, including the return of table borders.

Change-Id: I22b652e1eb007616e697cb238fcd9e5f010cd693
2019-06-06 14:27:41 +08:00
pengyuesheng 0731cd1d87 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: Ia9ab0cfb134f0f6ca168e8e746582fe1fc7c9710
2019-06-06 11:02:02 +08:00
Hervé Beraud 831162ac0a Constraint networkx to <2.3 for Python 2
NetworkX released 2.3, dropping support for Python 2.

 https://github.com/networkx/networkx/blob/master/doc/news.rst

 Also see I0a9700926c9a0db93e782c853c33f1aaee3d4876

 fixed sphinx requirements also according to global requirements
 
 jsonschema should be uncaped also according to global requirements
 but there are conflicts with zakarclient designateclient and irconicclient
 
 so for now I put it in remark

Change-Id: Iea3dbcfa1f6ddf2c413ede5e73fa076c6edccfdf
2019-05-23 09:10:07 +00:00
Nguyen Van Trung 69d34b2e85 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more details information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I4dd494a46011aa8547f52b442f9cba4d402fb91a
2018-07-09 14:54:23 +07:00