Commit Graph

6 Commits

Author SHA1 Message Date
shanyunfan33 fbf8091364 remove unicode from code
remove unicode from code

Change-Id: Ief9d24e83d74c1f7bf17c96abd713ee5b563361d
2022-08-12 14:41:59 +00: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
Dougal Matthews 540f8d67e7 Remove the invalid toctree
The reference to v2/index doesn't exist, causing the build to fail.
Given the api-ref documentation is currently empty, removing the toctree
wont cause any issues.

This makes the build green (test with `tox -e api-ref`), which will allow CI to
be enabled which may help further work on the api-ref.

Change-Id: I9893c3f629255ae2ae879a60fa341e3775b426ed
2018-01-31 04:16:42 +00:00
Dougal Matthews 0aaa43b469 Disable the wsme Sphinx extension from the API ref docs
This causes the following error:

    while setting up extension wsmeext.sphinxext: directive 'autoattribute' is
    already registered, it will be overridden

Change-Id: I22af68e8a455dd5b71ee427c81ae99f3d1391195
2018-01-26 08:34:53 +00:00
Sharat Sharma daf75c2852 Fix doc generation for python 3
The html_last_updated_fmt option is interpeted as a byte string in
python3, make it utf-8 string.

Change-Id: I7ba038ea1bca354681f973d68c06eb3c4bfa6e29
2017-05-23 14:38:54 +00:00
Sharat Sharma 51279dd862 Initial commit for mistral api-ref
This adds the repo for api-ref for mistral api reference. The api
can be documented in the files added.

Change-Id: I624abe6caee01e577ff8cda1660cbd8722856135
Partial-Implements: blueprint mistral-api-ref
2017-01-11 18:19:39 +05:30