From: Carsten Schoenert Date: Tue, 17 Nov 2020 20:18:45 +0100 Subject: Use anonymous reference for linking Forwarded: https://github.com/HewlettPackard/python-ilorest-library/pull/162 --- docs/Client-Quick-Start.rest | 16 ++++++++-------- docs/Monolith.rest | 10 +++++----- docs/Quick-Start.rest | 16 ++++++++-------- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/Client-Quick-Start.rest b/docs/Client-Quick-Start.rest index 906ff53..d42a57a 100644 --- a/docs/Client-Quick-Start.rest +++ b/docs/Client-Quick-Start.rest @@ -11,14 +11,14 @@ Client Quick Start ================== -This section describes the basic functionality of the library for users, who only need a basic client configured for a LegacyRest or Redfish host. For a convenient class for performing higher level functionality or for users unfamiliar with Redfish implementations, see `RmcApp Usage `_. +This section describes the basic functionality of the library for users, who only need a basic client configured for a LegacyRest or Redfish host. For a convenient class for performing higher level functionality or for users unfamiliar with Redfish implementations, see `RmcApp Usage `__. This Quick Start covers client object creation, a simple call to the API, and a response object. -Scripts of the information provided below are available at: `quickstart_redfish.py `_ -and `quickstart_legacy_rest.py `_. +Scripts of the information provided below are available at: `quickstart_redfish.py `__ +and `quickstart_legacy_rest.py `__. -For more elaborate examples that use the Redfish API and the python-ilorest-library, see the `Examples `_ section. +For more elaborate examples that use the Redfish API and the python-ilorest-library, see the `Examples `__ section. The python-ilorest-library provides support for communication using both remote using HTTPS and local in-band using CHIF. @@ -51,7 +51,7 @@ Create a Redfish Object Creation of a Redfish object instance is done using the **RedfishClient** class instead of the **redfish_client** function. **RedfishClient** takes as parameters iLO hostname/IP address, username, password, and other optional arguments. -For a full list of optional arguments see `here `_. +For a full list of optional arguments see `here `__. .. code-block:: python @@ -64,7 +64,7 @@ Create a LegacyRest Object Creation of a Legacy Rest object instance is done using the **LegacyRestClient** class instead of the **rest_client** function. **LegacyRestClient** takes as parameters iLO hostname/IP address, username, password, and other optional arguments. -For a full list of optional arguments see `here `_. +For a full list of optional arguments see `here `__. .. code-block:: python @@ -181,7 +181,7 @@ The formated Response body (Truncated for size): .. literalinclude:: redfish_quick.json :language: JSON -A full description of the Response Object is available in the reference `here `_. +A full description of the Response Object is available in the reference `here `__. Other HTTP Requests =================== @@ -206,4 +206,4 @@ Continued Reading ================= That's it! You're ready to perform some Redfish requests! If you are looking for more advanced topics like -*setting timeouts*, more detail on the *response* object, or configuration of the *Redfish* or *LegacyRest* objects check out the `Advanced Usage `_ section. +*setting timeouts*, more detail on the *response* object, or configuration of the *Redfish* or *LegacyRest* objects check out the `Advanced Usage `__ section. diff --git a/docs/Monolith.rest b/docs/Monolith.rest index fc46602..da5cf8c 100644 --- a/docs/Monolith.rest +++ b/docs/Monolith.rest @@ -21,7 +21,7 @@ Direct Monolith Usage Direct usage of the monolith can be useful for crawling an entire tree or creating your own app implementation. The first thing we need to do is create a client and login. -If you are unfamiliar with clients, please see the `Quickstart section `_. +If you are unfamiliar with clients, please see the `Quickstart section `__. Creating a monolith ------------------- @@ -31,7 +31,7 @@ Creating a monolith >>> REST_OBJ.login() Then, we need to create a compatibility instance that goes along with this client. For more information -on this compatibility class, see `System Compatibility `_. +on this compatibility class, see `System Compatibility `__. >>> from redfish.ris.gen_compat import Typesandpathdefines >>> COMPAT_OBJ = Typesandpathdefines() @@ -125,7 +125,7 @@ AttributeError: 'NoneType' object has no attribute 'dict' .. note:: Any response without a json response will return an **AttributeError** -For a full list of options in **load**, see the resource documentation `here `_. +For a full list of options in **load**, see the resource documentation `here `__. RmcApp Usage ===================== @@ -133,7 +133,7 @@ RmcApp Usage The RmcApp class is a convenience class that combines the client, compatibility, validation, caching, and monolith into one class. RmcApp supplies functions for easily interacting with a server and monolith. -For full functionality see the reference on RmcApp `here `_. +For full functionality see the reference on RmcApp `here `__. Creating the RmcApp class ------------------------- @@ -252,7 +252,7 @@ We can double check our setting applied with another getprops call. Performing Actions ****************** -Actions are just **POST** operations. They can be performed with the RmcApp handlers for raw HTTP commands. See the `post_handler `_. +Actions are just **POST** operations. They can be performed with the RmcApp handlers for raw HTTP commands. See the `post_handler `__. HTTP handlers ************* diff --git a/docs/Quick-Start.rest b/docs/Quick-Start.rest index 87edfcd..e35a901 100644 --- a/docs/Quick-Start.rest +++ b/docs/Quick-Start.rest @@ -12,10 +12,10 @@ Quick Start This will cover object creation, a simple call to the API, and a response object. -Scripts of the information provided below are available at: `quickstart_redfish.py `_ -and `quickstart_legacy_rest.py `_. +Scripts of the information provided below are available at: `quickstart_redfish.py `__ +and `quickstart_legacy_rest.py `__. -For more elaborate examples that use the Redfish API and python-ilorest-library check out the `Examples `_ section. +For more elaborate examples that use the Redfish API and python-ilorest-library check out the `Examples `__ section. The python-ilorest-library provides support for communication using both remote using HTTPS and local in-band using CHIF. @@ -48,7 +48,7 @@ Create a Redfish Object Creation of a Redfish object instance is done using the **RedfishClient** class instead of the **redfish_client** function. **RedfishClient** takes as parameters iLO hostname/ip address, username, password, and other optional arguments. -For a full list of optional arguments see `here `_. +For a full list of optional arguments see `here `__. .. code-block:: python @@ -61,7 +61,7 @@ Create a LegacyRest Object Creation of a Legacy Rest object instance is done using the **LegacyRestClient** class instead of the **rest_client** function. **LegacyRestClient** takes as parameters iLO hostname/ip address, username, password, and other optional arguments. -For a full list of optional arguments see `here `_. +For a full list of optional arguments see `here `__. .. code-block:: python @@ -75,7 +75,7 @@ Requirements * You must be running on a server with iLO and the latest iLO drivers from the SPP. * You will need to download the iLOrest Chif DLL/SO for your corresponding operating system and place it in your working environment path. -By downloading, you agree to the terms and conditions of the `Hewlett Packard Enterprise Software License Agreement`_. +By downloading, you agree to the terms and conditions of the `Hewlett Packard Enterprise Software License Agreement`_. Windows Download: ilorest_chif.dll_ @@ -178,7 +178,7 @@ The formated Response body (Truncated for size): .. literalinclude:: redfish_quick.json :language: JSON -A full description of the Response Object is available in the reference `here `_. +A full description of the Response Object is available in the reference `here `__. Other HTTP Requests ============================ @@ -203,4 +203,4 @@ Continued Reading ================= That's it! You're ready to perform some Redfish requests! If you are looking for more advanced topics like -*setting timeouts*, more detail on the *response* object, or configuration of the *Redfish* or *LegacyRest* objects check out the `Advanced Usage `_ section. \ No newline at end of file +*setting timeouts*, more detail on the *response* object, or configuration of the *Redfish* or *LegacyRest* objects check out the `Advanced Usage `__ section.