Skip to content

docs: fix the two remaining htmldocs CI warnings #4410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
grandixximo merged 2 commits into from
Aug 19, 2026
+5 −5
Merged

docs: fix the two remaining htmldocs CI warnings #4410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b7e696
docs: fix broken lcnc_realtime cross-references in python-hal-interface
grandixximo Aug 19, 2026
8da75f1
docs: use a listing block instead of a markdown fence in hm2_rpspi.9
grandixximo Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/src/config/python-hal-interface.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,9 @@ System information:
* `hal.kernel_version` - A string specifying the real-time kernel version if `hal.is_kernelspace` is one.
Otherwise it specifies `"Not Available"`.
* `hal.is_rt` - One (1) if the system runs in real-time, otherwise zero (0) *DEPRECATED*:
Use xref:python-lcnc_realtime.adoc[`lcnc_realtime.verify()`]
Use <<cha:python-lcnc_realtime,`lcnc_realtime.verify()`>>
* `hal.is_sim` - Inverted `hal.is_rt` *DEPRECATED*:
Use xref:python-lcnc_realtime.adoc[`lcnc_realtime.verify()`]
Use <<cha:python-lcnc_realtime,`lcnc_realtime.verify()`>>


=== hal methods
Expand All @@ -180,7 +180,7 @@ hal.get_realtime_type() -> hal.RTType::
Returns the type of the running realtime system.
Might return `hal.RTType.UNINITIALIZED` if `rtapi_app` is not running.
See xref:halconstantsrt[realtime type constants].
See also xref:python-lcnc_realtime.adoc[LinuxCNC Realtime check].
See also <<cha:python-lcnc_realtime,LinuxCNC Realtime check>>.

hal.component_exists(_name_:string) -> bool::
Returns a boolean to indicate whether or not the specified component exist at this time.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/man/man9/hm2_rpspi.9.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,10 @@ throwing off the SoC's PLL(s), resulting in strange behaviour.
For optimal performance on the RPi3, you must disable the "ondemand" CPU
frequency governor. You may add the following to your /etc/rc.local file:

```
----
echo -n 1200000 > /sys/devices/system/cpu/cpufreq/policy0/scaling_min_freq
echo -n performance > /sys/devices/system/cpu/cpufreq/policy0/scaling_governor
```
----

Be sure to have a proper heatsink mounted on the SoC or it will get too warm and crashes.

Expand Down