doc: Create directory structure for docs migration
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
This commit is contained in:
Stephen Finucane
parent
5a62b409fc
commit
9ca11e9be0
62
README.rst
62
README.rst
@ -1,8 +1,8 @@
|
||||
===============
|
||||
=========
|
||||
os-traits
|
||||
===============
|
||||
=========
|
||||
|
||||
A library containing standardized trait strings.
|
||||
`os-traits` is a library containing standardized trait strings.
|
||||
|
||||
Traits are strings that represent a feature of some resource provider. This
|
||||
library contains the catalog of constants that have been standardized in the
|
||||
@ -13,59 +13,3 @@ network, or device trait.
|
||||
* Documentation: http://docs.openstack.org/developer/os-traits
|
||||
* Source: http://git.openstack.org/cgit/openstack/os-traits
|
||||
* Bugs: http://bugs.launchpad.net/os-traits
|
||||
|
||||
Usage
|
||||
------
|
||||
|
||||
`os-traits` is primarily composed of a set of constants that may be referenced
|
||||
by simply importing the os_traits module and referencing one of the module's
|
||||
traits constants::
|
||||
|
||||
$ python
|
||||
Python 2.7.11+ (default, Apr 17 2016, 14:00:29)
|
||||
[GCC 5.3.1 20160413] on linux2
|
||||
Type "help", "copyright", "credits" or "license" for more information.
|
||||
>>> import os_traits as ot
|
||||
>>> print ot.HW_CPU_X86_SSE42
|
||||
HW_CPU_X86_SSE42
|
||||
|
||||
You can get a list of the os_traits symbols by simply doing a dir(os_traits).
|
||||
|
||||
Want to see the trait strings for a subset of traits? There's a method for that too::
|
||||
|
||||
>>> pprint.pprint(ot.get_traits(ot.NAMESPACES['X86']))
|
||||
['HW_CPU_X86_AES-NI',
|
||||
'HW_CPU_X86_AVX512ER',
|
||||
'HW_CPU_X86_AVX512CD',
|
||||
'HW_CPU_X86_TBM',
|
||||
'HW_CPU_X86_TSX',
|
||||
'HW_CPU_X86_FMA3',
|
||||
'HW_CPU_X86_SVM',
|
||||
'HW_CPU_X86_FMA4',
|
||||
'HW_CPU_X86_MPX',
|
||||
'HW_CPU_X86_SSE2',
|
||||
'HW_CPU_X86_SSE3',
|
||||
'HW_CPU_X86_MMX',
|
||||
'HW_CPU_X86_SSSE3',
|
||||
'HW_CPU_X86_SSE4A',
|
||||
'HW_CPU_X86_AVX2',
|
||||
'HW_CPU_X86_SGX',
|
||||
'HW_CPU_X86_AVX',
|
||||
'HW_CPU_X86_AVX512BW',
|
||||
'HW_CPU_X86_AVX512DQ',
|
||||
'HW_CPU_X86_SSE',
|
||||
'HW_CPU_X86_SHA',
|
||||
'HW_CPU_X86_AVX512F',
|
||||
'HW_CPU_X86_F16C',
|
||||
'HW_CPU_X86_SSE41',
|
||||
'HW_CPU_X86_SSE42',
|
||||
'HW_CPU_X86_VMX',
|
||||
'HW_CPU_X86_ASF',
|
||||
'HW_CPU_X86_BMI2',
|
||||
'HW_CPU_X86_CLMUL',
|
||||
'HW_CPU_X86_AVX512VL',
|
||||
'HW_CPU_X86_AVX512PF',
|
||||
'HW_CPU_X86_XOP',
|
||||
'HW_CPU_X86_BMI',
|
||||
'HW_CPU_X86_ABM',
|
||||
'HW_CPU_X86_3DNOW']
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
============
|
||||
Contributing
|
||||
============
|
||||
.. include:: ../../CONTRIBUTING.rst
|
||||
5
doc/source/contributor/index.rst
Normal file
5
doc/source/contributor/index.rst
Normal file
@ -0,0 +1,5 @@
|
||||
============
|
||||
Contributing
|
||||
============
|
||||
|
||||
.. include:: ../../../CONTRIBUTING.rst
|
||||
@ -1,25 +1,42 @@
|
||||
.. os-traits documentation master file, created by
|
||||
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
=========
|
||||
os-traits
|
||||
=========
|
||||
|
||||
Welcome to os-traits' documentation!
|
||||
========================================================
|
||||
`os-traits` is a library containing standardized trait strings.
|
||||
|
||||
Contents:
|
||||
Traits are strings that represent a feature of some resource provider. This
|
||||
library contains the catalog of constants that have been standardized in the
|
||||
OpenStack community to refer to a particular hardware, virtualization, storage,
|
||||
network, or device trait.
|
||||
|
||||
Installation Guide
|
||||
------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
installation
|
||||
usage
|
||||
contributing
|
||||
install/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
Usage Guide
|
||||
-----------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
user/index
|
||||
|
||||
Contributor Guide
|
||||
-----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
contributor/index
|
||||
|
||||
Reference
|
||||
---------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
reference/index
|
||||
|
||||
@ -1 +0,0 @@
|
||||
.. include:: ../../README.rst
|
||||
5
doc/source/reference/index.rst
Normal file
5
doc/source/reference/index.rst
Normal file
@ -0,0 +1,5 @@
|
||||
=========
|
||||
Reference
|
||||
=========
|
||||
|
||||
TODO.
|
||||
@ -1,7 +0,0 @@
|
||||
========
|
||||
Usage
|
||||
========
|
||||
|
||||
To use os-traits in a project::
|
||||
|
||||
import os_traits
|
||||
58
doc/source/user/index.rst
Normal file
58
doc/source/user/index.rst
Normal file
@ -0,0 +1,58 @@
|
||||
=====
|
||||
Usage
|
||||
=====
|
||||
|
||||
`os-traits` is primarily composed of a set of constants that may be referenced
|
||||
by simply importing the ``os_traits`` module and referencing one of the
|
||||
module's traits constants::
|
||||
|
||||
$ python
|
||||
Python 2.7.11+ (default, Apr 17 2016, 14:00:29)
|
||||
[GCC 5.3.1 20160413] on linux2
|
||||
Type "help", "copyright", "credits" or "license" for more information.
|
||||
>>> import os_traits as ot
|
||||
>>> print ot.HW_CPU_X86_SSE42
|
||||
HW_CPU_X86_SSE42
|
||||
|
||||
You can get a list of the ``os_traits`` symbols by simply doing a
|
||||
``dir(os_traits)``.
|
||||
|
||||
Want to see the trait strings for a subset of traits? There's a method for that
|
||||
too::
|
||||
|
||||
>>> pprint.pprint(ot.get_traits(ot.NAMESPACES['X86']))
|
||||
['HW_CPU_X86_AES-NI',
|
||||
'HW_CPU_X86_AVX512ER',
|
||||
'HW_CPU_X86_AVX512CD',
|
||||
'HW_CPU_X86_TBM',
|
||||
'HW_CPU_X86_TSX',
|
||||
'HW_CPU_X86_FMA3',
|
||||
'HW_CPU_X86_SVM',
|
||||
'HW_CPU_X86_FMA4',
|
||||
'HW_CPU_X86_MPX',
|
||||
'HW_CPU_X86_SSE2',
|
||||
'HW_CPU_X86_SSE3',
|
||||
'HW_CPU_X86_MMX',
|
||||
'HW_CPU_X86_SSSE3',
|
||||
'HW_CPU_X86_SSE4A',
|
||||
'HW_CPU_X86_AVX2',
|
||||
'HW_CPU_X86_SGX',
|
||||
'HW_CPU_X86_AVX',
|
||||
'HW_CPU_X86_AVX512BW',
|
||||
'HW_CPU_X86_AVX512DQ',
|
||||
'HW_CPU_X86_SSE',
|
||||
'HW_CPU_X86_SHA',
|
||||
'HW_CPU_X86_AVX512F',
|
||||
'HW_CPU_X86_F16C',
|
||||
'HW_CPU_X86_SSE41',
|
||||
'HW_CPU_X86_SSE42',
|
||||
'HW_CPU_X86_VMX',
|
||||
'HW_CPU_X86_ASF',
|
||||
'HW_CPU_X86_BMI2',
|
||||
'HW_CPU_X86_CLMUL',
|
||||
'HW_CPU_X86_AVX512VL',
|
||||
'HW_CPU_X86_AVX512PF',
|
||||
'HW_CPU_X86_XOP',
|
||||
'HW_CPU_X86_BMI',
|
||||
'HW_CPU_X86_ABM',
|
||||
'HW_CPU_X86_3DNOW']
|
||||
Loading…
Reference in New Issue
Block a user