Commit Graph

9 Commits

Author SHA1 Message Date
U-HOME\songwenping 87b1165aa3 Remove unnecessary unicode prefixes
All strings are unicode by default in Python 3. No need to mark them as
such.

Change-Id: Id937b87f7c7e2767ce5eb456db39d8ce81a1a69a
2022-04-19 14:32:05 +08:00
Stephen Finucane c6a0ff2ac0 List traits in documentation
We're going to have to switch to something other than a list of strings
or use Sphinx-style inline documentation if we want to provide anything
more useful.

Change-Id: I45c29fe2bdd3fdcb3c69e07f5e9e5be36de9b797
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-09-23 12:05:41 +01:00
Andreas Jaeger e32a13f13c 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.

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: Id6a7a465630647382de63be64fc16f6e4f52912d
2020-06-01 15:28:05 +02:00
Andreas Jaeger 77bf79e2aa 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
- Switch to using sphinx-build
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Switch to hacking 3.0

Change-Id: Id3a7e6b6a6160358efb897cbf73630d96672d4fb
2020-04-12 18:52:38 +02:00
Chris Dent d2d56c291b Build pdf docs
This follows the instructions [1] in an attempt to build pdf docs.

The goal is described as docs that get made, not necessarily
perfect docs. This gets that.

[1] https://etherpad.openstack.org/p/train-pdf-support-goal

Change-Id: Icf7c22bf9d1de6fb2a74a756c370930d4c00b0b9
Story: 2006110
Task: 35396
2019-09-11 13:24:44 +00:00
Stephen Finucane 21b879b755 doc: Remove cruft from conf.py
Clean up both the releasenotes 'conf.py' and some remaining pieces of
the main 'conf.py'. In the case of the former, it looks like this was
copied from Glance's config, and retains a lot of unnecessary config for
same. Remove it all.

Change-Id: Ibce322af4441fef7ba0b1abe1b51070d49ad1df5
2017-08-23 09:46:37 +01:00
Stephen Finucane 5c46158f38 doc: Switch from oslosphinx to openstackdocstheme
Change-Id: I471868446a4ac89a63cc75b0d83caae21bd90fb8
2017-08-23 09:46:35 +01:00
Yingxin d56ac9facb Rename the rest capabilities to traits 2016-09-20 05:40:55 +00:00
Jay Pipes 7d2a583f32 Initial commit of os-capabilities library
Adds the basics of the new os-capabilities library, including a README
and a couple helper functions that allow the user to list both symbol
names as well as the capability strings themselves.

Added x86 CPU instruction set extensions as an initial set of namespaced
standardized capability strings.
2016-08-03 19:25:39 -04:00