Skip to content

Commit c2216c8

Browse files
committed
docs: Not having index on title line
1 parent b8f90d7 commit c2216c8

30 files changed

+313
-146
lines changed

docs/src/code/contributing-to-linuxcnc.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ G-code programs in a directory called `$HOME/linuxcnc`, and having the
5656
git repo there too is confusing.
5757

5858
Issues and pull requests (abbreviated PRs) are welcome on GitHub:
59-
https://github.com/LinuxCNC/linuxcnc/issues
60-
https://github.com/LinuxCNC/linuxcnc/pulls
59+
. https://github.com/LinuxCNC/linuxcnc/issues
60+
. https://github.com/LinuxCNC/linuxcnc/pulls
6161

6262
=== Use of Git in the LinuxCNC project
6363

docs/src/config/core-components.adoc

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,21 @@
22
:toc:
33

44
[[cha:core-components]]
5-
= Core Components(((Core components)))
5+
= Core Components
66

77
// Custom lang highlight
88
// must come after the doc title, to work around a bug in asciidoc 8.6.6
99
:ini: {basebackend@docbook:'':ini}
1010
:hal: {basebackend@docbook:'':hal}
1111
:ngc: {basebackend@docbook:'':ngc}
1212

13+
(((Core components)))
1314
See also the man pages 'motion(9)'.
1415

1516
[[sec:motion]]
16-
== Motion (((Motion)))
17+
== Motion
1718

19+
(((Motion)))
1820
These pins and parameters are created by the realtime 'motmod' module.
1921

2022
This module provides a HAL interface for LinuxCNC's motion planner.
@@ -93,8 +95,9 @@ unlock_joints_mask=0x38 selects joints 3,4,5
9395
----
9496

9597
[[sec:motion-pins]]
96-
=== Pins(((motion:HAL pins)))
98+
=== Pins
9799

100+
(((motion:HAL pins)))
98101
These pins, parameters, and functions are created by the realtime 'motmod' module.
99102

100103
* 'motion.adaptive-feed' - (float, in) When adaptive feed is enabled with 'M52 P1' , the
@@ -193,8 +196,9 @@ Motion will produce the following pins:
193196
The __N__ (integer between 0 and 7) substitutes the spindle number.
194197

195198
[[sec:spindle-pins]]
196-
=== Pins(((spindle (HAL pins))))
199+
=== Pins
197200

201+
(((spindle (HAL pins))))
198202
* 'spindle.__N__.at-speed' - (bit, in)
199203
Motion will pause until this pin is TRUE, under the following conditions:
200204
** before the first feed move after each spindle start or speed change;
@@ -301,8 +305,9 @@ iocontrol - accepts non-realtime I/O commands via NML, interacts with HAL.
301305

302306
iocontrol's HAL pins are turned on and off in non-realtime context. If you have strict timing requirements or simply need more I/O, consider using the realtime synchronized I/O provided by <<sec:motion,motion>> instead.
303307

304-
=== Pins (((iocontrol (HAL pins))))
308+
=== Pins
305309

310+
(((iocontrol (HAL pins))))
306311
* 'iocontrol.0.coolant-flood' (bit, out) TRUE when flood coolant is requested.
307312
* 'iocontrol.0.coolant-mist' (bit, out) TRUE when mist coolant is requested.
308313
* 'iocontrol.0.emc-enable-in' (bit, in) Should be driven FALSE when an external E-Stop condition exists.
@@ -319,8 +324,9 @@ iocontrol's HAL pins are turned on and off in non-realtime context. If you have
319324

320325
A number of INI settings are made available as HAL input pins.
321326

322-
=== Pins (((INI settings (HAL pins))))
327+
=== Pins
323328

329+
(((INI settings (HAL pins))))
324330
_N_ refers to a joint number, _L_ refers to an axis letter.
325331

326332
* 'ini.__N__.ferror' - (float, in) [JOINT_N]FERROR

0 commit comments

Comments
 (0)