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>
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
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
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
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Update some URLs to latest
3. Remove unncessary "=="
Change-Id: I1d57841c754169a3d770ab3d856a95874f68f4ba
Since the AMD SEV spec was approved for Stein, it was subsequently
realised that a trait would not be sufficient for tracking SEV-capable
compute hosts. A resource class is also needed to track the inventory
of "slots" available on these hosts, since the number of slots limits
how many guests with encrypted memory can run concurrently.
Therefore the design pivoted somewhat, and now
trait:HW_CPU_AMD_SEV=required will not be the correct way to request
SEV functionality:
https://specs.openstack.org/openstack/nova-specs/specs/train/approved/amd-sev-libvirt-support.html
For reference, the previous spec is here:
https://specs.openstack.org/openstack/nova-specs/specs/stein/approved/amd-sev-libvirt-support.html
Another lesson learnt from the Stein cycle was that it is not safe to
assume that the work targeted for one cycle will actually land in that
cycle, therefore it's safer for documentation of an in-progress
feature to be transparent that it's in progress and not yet usable.
Change-Id: I6b652c20ba4f5ec775829a45939d708066dc3011
blueprint: amd-sev-libvirt-support
There was a misunderstanding of what the CUDA traits really stood for.
This wasn't helped by the fact that the NVIDIA CUDA documentation and
versioning system is so awkward.
Basically, there's the CUDA Compute Capability version, which represents
the hardware GPU instruction set extensions supported by various NVIDIA
GPUs. And there is the CUDA SDK version which represents a window of
CUDA Compute Capability versions that the library is able to work with.
This patch adds a new os_traits.hw.gpu.cuda module with these new
traits. It removes the old os_traits.hw.gpu.api.CUDA* traits since those
were misleading and inaccurate.
It also adds a new utility function that maps CUDA SDK version to
supported CUDA Compute Capability versions that the SDK supports. This
support matrix information was taken from the CUDA wikipedia article
which lists the supported version information.
Change-Id: Id4adb6874615ad5f9f8aff780a83119e10a38c35
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
The spec [1] recommends the following sections:
- install
- contributor
- configuration
- cli
- admin
- user
- reference
Only a few of these are useful here:
- install
- contributor
- user
- reference
Add these and populate them.
[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration
Change-Id: I70c77761a0a26a46d092bb09a29374b72c0d49ca
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.