Merge pull request #896 from llange/fix-documentation

fix a few documentation issues
openvehicles · May 12, 2023 · e7f41bd · e7f41bd
2 parents ae3a7b4 + 13581e4
commit e7f41bd
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/docs/source/userguide/installation.rst b/docs/source/userguide/installation.rst
@@ -16,7 +16,7 @@ Pre-Installation Steps
 Prior to installation, please make sure you have the following available:
 
 #. The OVMS v3 module in it's enclosure.
-#. A `Hologram https://hologram.io`_ (or other suitable) SIM card if you module did not come with one.
+#. A `Hologram <https://hologram.io>`_ (or other suitable) SIM card if you module did not come with one.
 #. A micro-usb cable suitable for connecting to your computer.
 #. A laptop or desktop computer (if necessary).
 #. A cable suitable for connecting to your vehicle.

diff --git a/docs/source/userguide/locations.rst b/docs/source/userguide/locations.rst
@@ -58,7 +58,7 @@ You could then update the radius to 80 meters as follows::
   OVMS# location radius home 80 meters
 
 When the car enters the above location, you will get an event "location.enter.home", and when it leaves, you will get the event "location.leave.home".
-See :doc:`events.rst` for how to add scripts.
+See :doc:`events` for how to add scripts.
 There are also limited actions you can define. For help on how see::
 
   OVMS# location action ?

diff --git a/vehicle/OVMS.V3/components/ovms_webserver/docs/metrics.rst b/vehicle/OVMS.V3/components/ovms_webserver/docs/metrics.rst
@@ -18,7 +18,8 @@ So for example the user could configure distance values to be in miles, and in t
 The user conversion information is contained in another object ``units``.  ``units.metrics``
 has the user configuration for each metric and ``units.prefs`` has the user configuration
 for each group of metrics (distance, temperature, consumption, pressure etc). There also some methods
-for general conversions allowing user preferences.
+for general conversions allowing user preferences:
+
 - The method ``units.unitLabelToUser(unitType,name)`` will return the user
   defined label for that 'unitType', defaulting to ``name``.
 - The method ``units.unitValueToUser(unitType,value)`` will convert ``value``

diff --git a/vehicle/OVMS.V3/components/vehicle_minise/docs/index.rst b/vehicle/OVMS.V3/components/vehicle_minise/docs/index.rst
@@ -1,7 +1,7 @@
 
-=============
+==============
 Mini Cooper SE
-=============
+==============
 
 Vehicle Type: **Mini Cooper SE**