Skip to content

Commit

Permalink
Adjusted RTD links to use /en/master version
Browse files Browse the repository at this point in the history
Signed-off-by: Andreas Maier <maiera@de.ibm.com>
  • Loading branch information
andy-maier committed Jun 26, 2024
1 parent 25ddfc5 commit 3ce8a81
Show file tree
Hide file tree
Showing 10 changed files with 38 additions and 39 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ $ pip install zhmcclient
```

For more details, see the
[Installation section](http://python-zhmcclient.readthedocs.io/en/latest/intro.html#installation)
[Installation section](http://python-zhmcclient.readthedocs.io/en/master/intro.html#installation)
in the documentation.

# Quickstart
Expand Down Expand Up @@ -82,9 +82,9 @@ P0000M96 PART1

For the latest released version on PyPI:

- [Documentation](http://python-zhmcclient.readthedocs.io/en/latest/)
- [Documentation](http://python-zhmcclient.readthedocs.io)
- [Change
log](http://python-zhmcclient.readthedocs.io/en/latest/changes.html)
log](http://python-zhmcclient.readthedocs.io/en/master/changes.html)

# zhmc CLI

Expand All @@ -101,7 +101,7 @@ dependencies.
# Contributing

For information on how to contribute to this project, see the
[Development section](http://python-zhmcclient.readthedocs.io/en/latest/development.html)
[Development section](http://python-zhmcclient.readthedocs.io/en/master/development.html)
in the documentation.

# License
Expand Down
2 changes: 1 addition & 1 deletion changes/1567.cleanup.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Docs: Reduced number of versions shown in generated documentation to only
the latest fix version of each minor version, and the master version.
Updated the release instructions accordingly.
Updated the release instructions and links in the documentation accordingly.
2 changes: 1 addition & 1 deletion docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -885,7 +885,7 @@ local clone of the python-zhmcclient Git repo.

- Verify that the new version ``M.N.U`` has been built successfully
and shows up at
https://python-zhmcclient.readthedocs.io/en/latest/changes.html.
https://python-zhmcclient.readthedocs.io/en/master/changes.html.
If you cannot see the new version once its build is complete, a typical
issue may be that it was not activated automatically. Activate the new
version in that case.
Expand Down
2 changes: 1 addition & 1 deletion docs/notebooks/01_notebook_basics.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"\n",
"This page (and its file, `01_notebook_basics.ipynb`) is termed a *notebook*. Each notebook when opened in Jupyter, is a Python main module that can do anything a normal Python module can do. Specifically, different code sections can be executed one by one and execute all in the same Python main module.\n",
"\n",
"If you view this notebook using the Online Notebook Viewer (e.g. because you clicked on the link in section [Tutorials](https://python-zhmcclient.readthedocs.io/en/latest/tutorial.html#tutorials)), you cannot execute the code sections in the notebook or modify the notebook. Section [Executing code in the tutorials](https://python-zhmcclient.readthedocs.io/en/latest/tutorial.html#executing-code-in-the-tutorials) describes how to do that.\n",
"If you view this notebook using the Online Notebook Viewer (e.g. because you clicked on the link in section [Tutorials](https://python-zhmcclient.readthedocs.io/en/master/tutorial.html#tutorials)), you cannot execute the code sections in the notebook or modify the notebook. Section [Executing code in the tutorials](https://python-zhmcclient.readthedocs.io/en/master/tutorial.html#executing-code-in-the-tutorials) describes how to do that.\n",
"\n",
"A code section can be executed by selecting it and pressing Ctrl-Enter (That is for Linux; the key combination depends on the operating system you are using).\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/notebooks/02_connections.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"If it was not installed, close Jupyter, [install zhmcclient](https://python-zhmcclient.readthedocs.io/en/latest/intro.html#installation), and start Jupyter again."
"If it was not installed, close Jupyter, [install zhmcclient](https://python-zhmcclient.readthedocs.io/en/master/intro.html#installation), and start Jupyter again."
]
},
{
Expand Down
18 changes: 9 additions & 9 deletions docs/notebooks/03_datamodel.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
" In the zhmcclient package, all resources exposed by the HMC are encapsulated as Python objects. The following code section lists the CPCs managed by the HMC and examines the first [`Cpc`](https://python-zhmcclient.readthedocs.io/en/latest/resources.html#zhmcclient.Cpc) object in the list:"
" In the zhmcclient package, all resources exposed by the HMC are encapsulated as Python objects. The following code section lists the CPCs managed by the HMC and examines the first [`Cpc`](https://python-zhmcclient.readthedocs.io/en/master/resources.html#zhmcclient.Cpc) object in the list:"
]
},
{
Expand All @@ -66,11 +66,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The public symbols are (Python) properties or methods and are described in the zhmcclient documentation (see [`Cpc`](https://python-zhmcclient.readthedocs.io/en/latest/resources.html#zhmcclient.Cpc)).\n",
"The public symbols are (Python) properties or methods and are described in the zhmcclient documentation (see [`Cpc`](https://python-zhmcclient.readthedocs.io/en/master/resources.html#zhmcclient.Cpc)).\n",
"\n",
"This `Cpc` object has only three resource properties: `name`, `object-uri`, and `status`. The zhmcclient package provides these resource properties as a dictionary in the [`properties`](https://python-zhmcclient.readthedocs.io/en/latest/appendix.html#zhmcclient.BaseResource.properties) instance variable of the `Cpc` object. The names of these resource properties are unchanged from what the [HMC API](https://python-zhmcclient.readthedocs.io/en/latest/appendix.html#term-hmc-api) book defines. The zhmcclient documentation refers to the HMC API book for a list and description of the resource properties.\n",
"This `Cpc` object has only three resource properties: `name`, `object-uri`, and `status`. The zhmcclient package provides these resource properties as a dictionary in the [`properties`](https://python-zhmcclient.readthedocs.io/en/master/appendix.html#zhmcclient.BaseResource.properties) instance variable of the `Cpc` object. The names of these resource properties are unchanged from what the [HMC API](https://python-zhmcclient.readthedocs.io/en/master/appendix.html#term-hmc-api) book defines. The zhmcclient documentation refers to the HMC API book for a list and description of the resource properties.\n",
"\n",
"The [`list()`](https://python-zhmcclient.readthedocs.io/en/latest/resources.html#zhmcclient.CpcManager.list) method only returned these three resource properties, but a CPC resource has many more properties. In the HMC API, list operations generally return only a small set of the most important properties, mostly for identification and status of the resource.\n",
"The [`list()`](https://python-zhmcclient.readthedocs.io/en/master/resources.html#zhmcclient.CpcManager.list) method only returned these three resource properties, but a CPC resource has many more properties. In the HMC API, list operations generally return only a small set of the most important properties, mostly for identification and status of the resource.\n",
"\n",
"The following code retrieves the full set of resource properties for that CPC and prints them:"
]
Expand All @@ -92,7 +92,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Because of this behavior, a Python object representing a resource may not always have all properties of the resource present. The [`get_property()`](https://python-zhmcclient.readthedocs.io/en/latest/appendix.html#zhmcclient.BaseResource.get_property) method allows accessing a specific named property, and retrieves it from the HMC if not currently present in the Python object.\n",
"Because of this behavior, a Python object representing a resource may not always have all properties of the resource present. The [`get_property()`](https://python-zhmcclient.readthedocs.io/en/master/appendix.html#zhmcclient.BaseResource.get_property) method allows accessing a specific named property, and retrieves it from the HMC if not currently present in the Python object.\n",
"\n",
"The following code section again lists the CPCs, creating a `Cpc` object with only three resource properties. The `get_property()` method is then used to access a property that is not among the initial three properties. This causes all resource properties to be retrieved from the HMC and stored in the `Cpc` object. The requested one is returned from the method:"
]
Expand Down Expand Up @@ -158,7 +158,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The [`prop()`](https://python-zhmcclient.readthedocs.io/en/latest/appendix.html#zhmcclient.BaseResource.prop) method returns a resource property value and allows specifying a default value in case the property is invalid:"
"The [`prop()`](https://python-zhmcclient.readthedocs.io/en/master/appendix.html#zhmcclient.BaseResource.prop) method returns a resource property value and allows specifying a default value in case the property is invalid:"
]
},
{
Expand All @@ -176,9 +176,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The resources in the HMC are organized as a tree. The zhmcclient package reflects that in the organization of the Python objects representing these resources. The top-level object is [`Client`](https://python-zhmcclient.readthedocs.io/en/latest/general.html#zhmcclient.Client) which represents the HMC. It allows navigating to the CPCs managed by the HMC via its [`cpcs`](https://python-zhmcclient.readthedocs.io/en/latest/general.html#zhmcclient.Client.cpcs) property.\n",
"The resources in the HMC are organized as a tree. The zhmcclient package reflects that in the organization of the Python objects representing these resources. The top-level object is [`Client`](https://python-zhmcclient.readthedocs.io/en/master/general.html#zhmcclient.Client) which represents the HMC. It allows navigating to the CPCs managed by the HMC via its [`cpcs`](https://python-zhmcclient.readthedocs.io/en/master/general.html#zhmcclient.Client.cpcs) property.\n",
"\n",
"Each Python object representing a resource allows navigating down to its child resources, and each child resource allows navigating up to its parent resource. For example, a [`Cpc`](https://python-zhmcclient.readthedocs.io/en/latest/resources.html#zhmcclient.Cpc) object represents a CPC, and its [`lpars`](https://python-zhmcclient.readthedocs.io/en/latest/resources.html#zhmcclient.Cpc.lpars) instance variable allows navigating to the LPARs of the CPC, represented by [`Lpar`](https://python-zhmcclient.readthedocs.io/en/latest/resources.html#zhmcclient.Lpar) objects. An `Lpar` object allows navigating up to its parent `Cpc` object via the generic [`manager.parent`](https://python-zhmcclient.readthedocs.io/en/latest/appendix.html#zhmcclient.BaseManager.parent) instance variable, and also via the specific [`manager.cpc`](https://python-zhmcclient.readthedocs.io/en/latest/resources.html#zhmcclient.LparManager.cpc) instance variable that is named according to the type of parent.\n",
"Each Python object representing a resource allows navigating down to its child resources, and each child resource allows navigating up to its parent resource. For example, a [`Cpc`](https://python-zhmcclient.readthedocs.io/en/master/resources.html#zhmcclient.Cpc) object represents a CPC, and its [`lpars`](https://python-zhmcclient.readthedocs.io/en/master/resources.html#zhmcclient.Cpc.lpars) instance variable allows navigating to the LPARs of the CPC, represented by [`Lpar`](https://python-zhmcclient.readthedocs.io/en/master/resources.html#zhmcclient.Lpar) objects. An `Lpar` object allows navigating up to its parent `Cpc` object via the generic [`manager.parent`](https://python-zhmcclient.readthedocs.io/en/master/appendix.html#zhmcclient.BaseManager.parent) instance variable, and also via the specific [`manager.cpc`](https://python-zhmcclient.readthedocs.io/en/master/resources.html#zhmcclient.LparManager.cpc) instance variable that is named according to the type of parent.\n",
"\n",
"The following code navigates from a `Cpc` object to its partitions (`Lpar` or `Partition` dependent on the CPC mode) and navigates back up from the first partition to its parent resource, which is the same `Cpc` Python object we started from:"
]
Expand Down Expand Up @@ -213,7 +213,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The [`find()`](https://python-zhmcclient.readthedocs.io/en/latest/appendix.html#zhmcclient.BaseManager.find) method retrieves a resource by specifying the value of one (or more) of its properties.\n",
"The [`find()`](https://python-zhmcclient.readthedocs.io/en/master/appendix.html#zhmcclient.BaseManager.find) method retrieves a resource by specifying the value of one (or more) of its properties.\n",
"\n",
"The following code finds the CPC we already know, based upon its name:"
]
Expand Down
Loading

0 comments on commit 3ce8a81

Please sign in to comment.