Skip to content

Commit

Permalink
More fixes for the cross references (#8750)
Browse files Browse the repository at this point in the history
* More fixes for the cross references

* Remove formatting from cross references
  • Loading branch information
adeas31 committed Mar 23, 2022
1 parent dac4475 commit cf1bf43
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
18 changes: 9 additions & 9 deletions doc/UsersGuide/source/packagemanager.rst
Expand Up @@ -127,23 +127,23 @@ Using the Package Manager from the Interactive Environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The Package Manager can also be used from the Interactive Environment command line shell. Here is a list
of examples of relevant commands; please type them followed by :ref:`getErrorString`,
e.g., :ref:`updatePackageIndex`;:ref:`getErrorString`, in order to get additional information,
of examples of relevant commands; please type them followed by :ref:`getErrorString() <getErrorString>`,
e.g., :ref:`updatePackageIndex() <updatePackageIndex>`; :ref:`getErrorString() <getErrorString>`, in order to get additional information,
notifications and error messages.

- *:ref:`updatePackageIndex`*: this command puts the Package Manager in contact with the OSMC servers and updates
- :ref:`updatePackageIndex() <updatePackageIndex>` - this command puts the Package Manager in contact with the OSMC servers and updates
the internally stored list of available packages;
- *:ref:`getAvailablePackageVersions`(Buildings, "")*: lists all available versions of the Buildings library on the OSMC server,
- :ref:`getAvailablePackageVersions(Building, "") <getAvailablePackageVersions>` - lists all available versions of the Buildings library on the OSMC server,
starting from the most recent one, in descending order of priority. Note that pre-release versions have lower priority
than all other versions;
- *:ref:`getAvailablePackageVersions`(Buildings, "7.0.0")*: lists all available versions of the Buildings library on
- :ref:`getAvailablePackageVersions(Building, "7.0.0") <getAvailablePackageVersions>` - lists all available versions of the Buildings library on
the OSMC server that are backwards-compatible with version ``7.0.0``, in descending order of priority;
- *:ref:`installPackage`(Buildings, "")*: install the most recent version of the Building libraries, *and all its dependencies*;
- *:ref:`installPackage`(Buildings, "7.0.0")*: install the most recent version of the Building libraries which is backwards-compatible
- :ref:`installPackage(Buildings, "") <installPackage>` - install the most recent version of the Building libraries, *and all its dependencies*;
- :ref:`installPackage(Buildings, "7.0.0") <installPackage>` - install the most recent version of the Building libraries which is backwards-compatible
with version ``7.0.0``, *and all its dependencies*;
- *:ref:`installPackage`(Buildings, "7.0.0", exactMatch = true)*: install version ``7.0.0`` even if there are more recent
- :ref:`installPackage(Buildings, "7.0.0", exactMatch = true) <installPackage>` - install version ``7.0.0`` even if there are more recent
backwards-compatible versions available, *and all its dependencies*;
- *:ref:`upgradeInstalledPackages`(installNewestVersions = true)*: installs the latest available version of all installed packages.
- :ref:`upgradeInstalledPackages(installNewestVersions = true) <upgradeInstalledPackages>` - installs the latest available version of all installed packages.

How the package index works
---------------------------
Expand Down
3 changes: 1 addition & 2 deletions doc/UsersGuide/source/plotting.rst
Expand Up @@ -33,8 +33,7 @@ simulation data:
:name: HelloWorld_res.csv
:caption: HelloWorld_res.csv
Diagrams are now created with the new OMPlot program by using the
following plot command:
Use `plot(x)` to plot the diagram using OMPlot.

.. omc-gnuplot :: helloworld
:caption: Simple 2D plot of the HelloWorld example.
Expand Down

0 comments on commit cf1bf43

Please sign in to comment.