Update documentation
- Add python3 release. - Add a FAQ. - Various minor updates.
This commit is contained in:
parent
66cb53df4e
commit
351547b051
14
README.rst
14
README.rst
@ -9,10 +9,15 @@ NOTE::
|
|||||||
|
|
||||||
DRAFT - WORK IN PROGRESS
|
DRAFT - WORK IN PROGRESS
|
||||||
|
|
||||||
The current Redfish specification revision is 1.0.0 - Note that the mockup
|
The current Redfish specification revision is 1.0.0 - Note that the mockup
|
||||||
is still at version 0.99.0a and may not reflect what the standard provides
|
is still at version 0.99.0a and may not reflect what the standard provides
|
||||||
fully
|
fully
|
||||||
|
|
||||||
|
Documentation
|
||||||
|
-------------
|
||||||
|
|
||||||
|
The full documentation is available at
|
||||||
|
http://pythonhosted.org/python-redfish/installation.html
|
||||||
|
|
||||||
Project Structure
|
Project Structure
|
||||||
-------------------
|
-------------------
|
||||||
@ -35,7 +40,7 @@ for build and test automation::
|
|||||||
Requirements
|
Requirements
|
||||||
------------
|
------------
|
||||||
|
|
||||||
To use the enclosed examples, you will need Python 2.7
|
To use the enclosed examples, you will need Python 2.7 or Python 3.4
|
||||||
(https://www.python.org/downloads/). Note that Python 2.7.9 enforces greater
|
(https://www.python.org/downloads/). Note that Python 2.7.9 enforces greater
|
||||||
SSL verification requiring server certificates be installed. Parameters to
|
SSL verification requiring server certificates be installed. Parameters to
|
||||||
relax the requirements are available in the library, but these configurations
|
relax the requirements are available in the library, but these configurations
|
||||||
@ -44,6 +49,9 @@ are discouraged due to security.
|
|||||||
Python requirements are listed in requirements.txt; additional requirements for
|
Python requirements are listed in requirements.txt; additional requirements for
|
||||||
running the unit test suite are listed in test-requirements.txt.
|
running the unit test suite are listed in test-requirements.txt.
|
||||||
|
|
||||||
|
Note: The program was tested with Python 2.7.10 and 3.4.2 however it might work
|
||||||
|
as well with all Python 3 releases.
|
||||||
|
|
||||||
Get the sources
|
Get the sources
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
|
11
doc/source/faq.rst
Normal file
11
doc/source/faq.rst
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
===
|
||||||
|
FAQ
|
||||||
|
===
|
||||||
|
|
||||||
|
- Q1 : error in setup command: Invalid environment marker: (python_version < '3')
|
||||||
|
|
||||||
|
This error is caused by old setuptools revisions that do not understant "python_version < '3'".
|
||||||
|
Upgrade setuptools using::
|
||||||
|
|
||||||
|
pip install --upgrade setuptools
|
||||||
|
|
@ -18,6 +18,7 @@ Contents:
|
|||||||
testing
|
testing
|
||||||
classesdoc
|
classesdoc
|
||||||
contributing
|
contributing
|
||||||
|
faq
|
||||||
help
|
help
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
@ -15,6 +15,10 @@ refish-client tests
|
|||||||
#. Install docker using the `procedure <https://docs.docker.com/engine/installation/>`_.
|
#. Install docker using the `procedure <https://docs.docker.com/engine/installation/>`_.
|
||||||
#. Ensure you can use docker with your current user.
|
#. Ensure you can use docker with your current user.
|
||||||
#. Jump into redfish-python directory containing the sources.
|
#. Jump into redfish-python directory containing the sources.
|
||||||
|
#. Depending of your distribution, you may have to upgrade setuptools::
|
||||||
|
|
||||||
|
pip install --upgrade setuptools
|
||||||
|
|
||||||
#. Install required modules for testings::
|
#. Install required modules for testings::
|
||||||
|
|
||||||
pip install -t test-requirements.txt
|
pip install -t test-requirements.txt
|
||||||
|
Loading…
Reference in New Issue
Block a user