From d637c874963f6f9e1045d8946730aefdbc28e00b Mon Sep 17 00:00:00 2001 From: myk002 Date: Fri, 22 Jul 2022 10:14:50 -0700 Subject: [PATCH] ensure all plugins are indexed --- docs/plugins/3dveins.rst | 6 ++++-- docs/plugins/add-spatter.rst | 9 +++++---- docs/plugins/autochop.rst | 5 +++-- docs/plugins/autodump.rst | 9 +++++---- docs/plugins/autogems.rst | 5 +++-- docs/plugins/automaterial.rst | 7 ++++--- docs/plugins/automelt.rst | 9 +++++---- docs/plugins/autotrade.rst | 9 +++++---- docs/plugins/building-hacks.rst | 3 ++- docs/plugins/burrows.rst | 11 ++++++----- 10 files changed, 42 insertions(+), 31 deletions(-) diff --git a/docs/plugins/3dveins.rst b/docs/plugins/3dveins.rst index ff230679b..3c1276b46 100644 --- a/docs/plugins/3dveins.rst +++ b/docs/plugins/3dveins.rst @@ -4,8 +4,8 @@ Tags: :dfhack-keybind:`3dveins` -:index:`Rewrites layer veins to expand in 3D space. -<3dveins; Rewrites layer veins to expand in 3D space.>` Existing, flat veins +:index:`Rewrite layer veins to expand in 3D space. +<3dveins; Rewrite layer veins to expand in 3D space.>` Existing, flat veins are removed and new 3D veins that naturally span z-levels are generated in their place. The transformation preserves the mineral counts reported by `prospect`. @@ -19,6 +19,8 @@ The ``verbose`` option prints out extra information to the console. Example ------- +:: + 3dveins New veins are generated using 3D Perlin noise in order to produce a layout that diff --git a/docs/plugins/add-spatter.rst b/docs/plugins/add-spatter.rst index 0c5c551b3..38a9f91f0 100644 --- a/docs/plugins/add-spatter.rst +++ b/docs/plugins/add-spatter.rst @@ -3,9 +3,10 @@ add-spatter Tags: -Make tagged reactions produce contaminants. The plugin is intended to give some -use to all those poisons that can be bought from caravans. It automatically -enables itself when you load a world with reactions that include names starting -with ``SPATTER_ADD_``. These reactions will then produce contaminants on items +:index:`Make tagged reactions produce contaminants. +` Give some use to all +those poisons that can be bought from caravans! The plugin automatically enables +itself when you load a world with reactions that include names starting with +``SPATTER_ADD_``. These reactions will then produce contaminants on items instead of improvements. The contaminants are immune to being washed away by water or destroyed by `clean`. diff --git a/docs/plugins/autochop.rst b/docs/plugins/autochop.rst index 3fc65144e..3a2284aef 100644 --- a/docs/plugins/autochop.rst +++ b/docs/plugins/autochop.rst @@ -3,8 +3,9 @@ autochop Tags: -Auto-harvest trees when low on stockpiled logs. This plugin can designate trees -for chopping when your stocks are low on logs. +:index:`Auto-harvest trees when low on stockpiled logs. +` This plugin can +designate trees for chopping when your stocks are low on logs. Usage:: diff --git a/docs/plugins/autodump.rst b/docs/plugins/autodump.rst index 45f5f90e1..a47878c34 100644 --- a/docs/plugins/autodump.rst +++ b/docs/plugins/autodump.rst @@ -6,10 +6,11 @@ Tags: :dfhack-keybind:`autodump-destroy-here` :dfhack-keybind:`autodump-destroy-item` -Automatically set items in a stockpile to be dumped. When `enabled `, -this plugin adds an option to the :kbd:`q` menu for stockpiles. When the -``autodump`` option is selected for the stockpile, any items placed in the -stockpile will automatically be designated to be dumped. +:index:`Automatically set items in a stockpile to be dumped. +` When +`enabled `, this plugin adds an option to the :kbd:`q` menu for +stockpiles. When the ``autodump`` option is selected for the stockpile, any +items placed in the stockpile will automatically be designated to be dumped. When invoked as a command, it can instantly move all unforbidden items marked for dumping to the tile under the cursor. After moving the items, the dump flag diff --git a/docs/plugins/autogems.rst b/docs/plugins/autogems.rst index e1dd294e3..bdfd51864 100644 --- a/docs/plugins/autogems.rst +++ b/docs/plugins/autogems.rst @@ -4,8 +4,9 @@ autogems Tags: :dfhack-keybind:`autogems-reload` -Automatically cut rough gems. This plugin periodically scans your stocks of -rough gems and creates manager orders for cutting them at a Jeweler's Workshop. +:index:`Automatically cut rough gems. ` +This plugin periodically scans your stocks of rough gems and creates manager +orders for cutting them at a Jeweler's Workshop. Usage: diff --git a/docs/plugins/automaterial.rst b/docs/plugins/automaterial.rst index 6c5e94c12..e51276772 100644 --- a/docs/plugins/automaterial.rst +++ b/docs/plugins/automaterial.rst @@ -3,9 +3,10 @@ automaterial Tags: -Sorts building materials by recent usage. This makes building constructions -(walls, floors, fortifications, etc) much easier by saving you from having to -trawl through long lists of materials each time you place one. +:index:`Sorts building materials by recent usage. +; Sorts building materials by recent usage.>` This makes building +constructions (walls, floors, fortifications, etc) much easier by saving you +from having to trawl through long lists of materials each time you place one. It moves the last used material for a given construction type to the top of the list, if there are any left. So if you build a wall with chalk blocks, the next diff --git a/docs/plugins/automelt.rst b/docs/plugins/automelt.rst index 38788ee93..b51a431c0 100644 --- a/docs/plugins/automelt.rst +++ b/docs/plugins/automelt.rst @@ -3,10 +3,11 @@ automelt Tags: -Quickly designate items to be melted. When `enabled `, this plugin adds -an option to the :kbd:`q` menu for stockpiles. When the ``automelt`` option is -selected for the stockpile, any items placed in the stockpile will automatically -be designated to be melted. +:index:`Quickly designate items to be melted. +` When `enabled `, this +plugin adds an option to the :kbd:`q` menu for stockpiles. When the ``automelt`` +option is selected for the stockpile, any items placed in the stockpile will +automatically be designated to be melted. Usage:: diff --git a/docs/plugins/autotrade.rst b/docs/plugins/autotrade.rst index 5a5053b8f..ed2d65bc5 100644 --- a/docs/plugins/autotrade.rst +++ b/docs/plugins/autotrade.rst @@ -3,10 +3,11 @@ autotrade Tags: -Quickly designate items to be traded. When `enabled `, this plugin adds -an option to the :kbd:`q` menu for stockpiles. When the ``autotrade`` option is -selected for the stockpile, any items placed in the stockpile will automatically -be designated to be traded. +:index:`Quickly designate items to be traded. +` When `enabled `, +this plugin adds an option to the :kbd:`q` menu for stockpiles. When the +``autotrade`` option is selected for the stockpile, any items placed in the +stockpile will automatically be designated to be traded. Usage:: diff --git a/docs/plugins/building-hacks.rst b/docs/plugins/building-hacks.rst index 0c20a474f..abd6ac4b4 100644 --- a/docs/plugins/building-hacks.rst +++ b/docs/plugins/building-hacks.rst @@ -3,7 +3,8 @@ building-hacks Tags: -Allows mods to create and manage powered workshops. +:index:`Allows mods to create and manage powered workshops. +` Usage:: diff --git a/docs/plugins/burrows.rst b/docs/plugins/burrows.rst index bc80e5bb1..6ab26caa2 100644 --- a/docs/plugins/burrows.rst +++ b/docs/plugins/burrows.rst @@ -4,13 +4,14 @@ burrows Tags: :dfhack-keybind:`burrow` -Auto-expand burrows as you dig. When a wall inside a burrow with a name ending -in ``+`` is dug out, the burrow will be extended to newly-revealed adjacent -walls. Note that digging 1-wide corridors with the miner inside the burrow is -SLOW. +:index:`Auto-expand burrows as you dig. +` When a wall inside a burrow +with a name ending in ``+`` is dug out, the burrow will be extended to +newly-revealed adjacent walls. Note that digging 1-wide corridors with the miner +inside the burrow is **SLOW**. You can also use the ``burrow`` command to -:index:`Quickly add units/tiles to burrows. +:index:`quickly add units/tiles to burrows. ` Usage: