Merge pull request #2286 from myk002/myk_lcase

lcase section headers in docs
DFHack · Sep 14, 2022 · eb53057 · eb53057
2 parents 4b7800f + 9117d1b
commit eb53057
Show file tree

Hide file tree

Showing 13 changed files with 32 additions and 24 deletions.
diff --git a/docs/Authors.rst b/docs/Authors.rst
@@ -1,4 +1,4 @@
-List of Authors
+List of authors
 ===============
 The following is a list of people who have contributed to DFHack, in
 alphabetical order.

diff --git a/docs/Compile.rst b/docs/Compile.rst
@@ -40,8 +40,8 @@ This will check out the code on the default branch of the GitHub repo, currently
 ``develop``, which may be unstable. If you want code for the latest stable
 release, you can check out the ``master`` branch instead::
 
-  git checkout master
-  git submodule update
+    git checkout master
+    git submodule update
 
 In general, a single DFHack clone is suitable for development - most Git
 operations such as switching branches can be done on an existing clone. If you

diff --git a/docs/Core.rst b/docs/Core.rst
@@ -9,7 +9,7 @@ DFHack Core
   :depth: 2
 
 
-Command Implementation
+Command implementation
 ======================
 DFHack commands can be implemented in any of three ways:
 
@@ -28,7 +28,7 @@ DFHack commands can be implemented in any of three ways:
 
 All tools distributed with DFHack are documented `here <genindex>`.
 
-Using DFHack Commands
+Using DFHack commands
 =====================
 DFHack commands can be executed in a number of ways:
 
@@ -38,7 +38,7 @@ DFHack commands can be executed in a number of ways:
 #. From one of several `init-files`, automatically
 #. Using `script` to run a batch of commands from a file
 
-The DFHack Console
+The DFHack console
 ------------------
 The command line has some nice line editing capabilities, including history
 that's preserved between different runs of DF - use :kbd:`↑` and :kbd:`↓`
@@ -115,7 +115,7 @@ second (Windows) example uses `kill-lua` to stop a Lua script.
 
 .. _dfhack-config:
 
-Configuration Files
+Configuration files
 ===================
 
 Most DFHack settings can be changed by modifying files in the ``dfhack-config``
@@ -125,7 +125,7 @@ necessary.
 
 .. _init-files:
 
-Init Files
+Init files
 ----------
 
 .. contents::
@@ -260,7 +260,7 @@ modified programmatically at any time through the `Lua API <lua-api-internal>`.
 
 .. _env-vars:
 
-Environment Variables
+Environment variables
 =====================
 
 DFHack's behavior can be adjusted with some environment variables. For example,
@@ -306,7 +306,7 @@ Other (non-DFHack-specific) variables that affect DFHack:
   sensitive), ``DF2CONSOLE()`` will produce UTF-8-encoded text. Note that this
   should be the case in most UTF-8-capable \*nix terminal emulators already.
 
-Miscellaneous Notes
+Miscellaneous notes
 ===================
 This section is for odd but important notes that don't fit anywhere else.
 

diff --git a/docs/Documentation.rst b/docs/Documentation.rst
@@ -1,7 +1,7 @@
 .. _documentation:
 
 ###########################
-DFHack Documentation System
+DFHack documentation system
 ###########################
 
 

diff --git a/docs/Introduction.rst b/docs/Introduction.rst
@@ -1,7 +1,7 @@
 .. _introduction:
 
 #########################
-Introduction and Overview
+Introduction and overview
 #########################
 
 DFHack is a Dwarf Fortress memory access library, distributed with

diff --git a/docs/Remote.rst b/docs/Remote.rst
@@ -1,7 +1,7 @@
 .. _remote:
 
 =======================
-DFHack Remote Interface
+DFHack remote interface
 =======================
 
 DFHack provides a remote access interface that external tools can connect to and
@@ -103,8 +103,6 @@ ID   Method       Input                           Output
  1   RunCommand   dfproto.CoreRunCommandRequest   dfproto.EmptyMessage
 ===  ============ =============================== =======================
 
-
-
 Conversation flow
 -----------------
 

diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -1,5 +1,5 @@
 ====================
-DFHack API Reference
+DFHack API reference
 ====================
 
 .. toctree::

diff --git a/docs/guides/examples-guide.rst b/docs/guides/examples-guide.rst
@@ -1,7 +1,7 @@
 .. _config-examples-guide:
 .. _dfhack-examples-guide:
 
-DFHack Config File Examples
+DFHack config file examples
 ===========================
 
 The :source:`hack/examples <data/examples>` folder contains ready-to-use

diff --git a/docs/guides/modding-guide.rst b/docs/guides/modding-guide.rst
@@ -3,6 +3,8 @@
 DFHack modding guide
 ====================
 
+.. highlight:: lua
+
 What is the difference between a script and a mod?
 --------------------------------------------------
 
@@ -182,6 +184,8 @@ call order.
 Custom raw tokens
 -----------------
 
+.. highlight:: none
+
 In this section, we are going to use `custom raw tokens <custom-raw-tokens>`
 applied to a reaction to transfer the material of a reagent to a product as a
 handle improvement (like on artifact buckets), and then we are going to see how
@@ -226,6 +230,8 @@ So, we are going to use the ``eventful`` module to make it so that (after the
 script is run) when this crossbow is crafted, it will have two handles, each
 with the material given by the block reagents.
 
+.. highlight:: lua
+
 First, require the modules we are going to use::
 
     local eventful = require("plugins.eventful")
@@ -292,6 +298,8 @@ Let's also make some code to modify the fire rate of our siege crossbow::
                 firer.counters.think_counter * multiplier)
     end
 
+.. highlight:: none
+
 Now, let's see how we could make some "pegasus boots". First, let's define the
 item in the raws::
 
@@ -312,6 +320,8 @@ item in the raws::
             (you don't have to comment the custom token every time,
             but it does clarify what it is)
 
+.. highlight:: lua
+
 Then, let's make a ``repeat-util`` callback for once a tick::
 
     repeatUtil.scheduleEvery(modId, 1, "ticks", function()

diff --git a/docs/guides/quickfort-alias-guide.rst b/docs/guides/quickfort-alias-guide.rst
@@ -1,6 +1,6 @@
 .. _quickfort-alias-guide:
 
-Quickfort Keystroke Alias Reference
+Quickfort keystroke alias reference
 ===================================
 
 Aliases allow you to use simple words to represent complicated key sequences

diff --git a/docs/guides/quickfort-library-guide.rst b/docs/guides/quickfort-library-guide.rst
@@ -1,7 +1,7 @@
 .. _blueprint-library-guide:
 .. _quickfort-library-guide:
 
-Quickfort Blueprint Library
+Quickfort blueprint library
 ===========================
 
 This guide contains a high-level overview of the blueprints available in the
@@ -194,7 +194,7 @@ Extra blueprints that are useful in specific situations.
 - :source:`library/embark.csv <data/blueprints/library/embark.csv>`
 - :source:`library/pump_stack.csv <data/blueprints/library/pump_stack.csv>`
 
-Light Aquifer Tap
+Light aquifer tap
 ~~~~~~~~~~~~~~~~~
 
 The aquifer tap helps you create a safe, everlasting source of fresh water from
@@ -216,7 +216,7 @@ blueprint that builds important starting workshops (mason, carpenter, mechanic,
 and craftsdwarf) and a ``#place`` blueprint that lays down a pattern of useful
 starting stockpiles.
 
-Pump Stack
+Pump stack
 ~~~~~~~~~~
 
 The pump stack blueprints help you move water and magma up to more convenient

diff --git a/docs/guides/quickfort-user-guide.rst b/docs/guides/quickfort-user-guide.rst
@@ -1,8 +1,8 @@
 .. _quickfort-blueprint-guide:
 .. _quickfort-user-guide:
 
-Quickfort Blueprint Editing Guide
-=================================
+Quickfort blueprint creation guide
+==================================
 
 `Quickfort <quickfort>` is a DFHack script that helps you build fortresses from
 "blueprint" .csv and .xlsx files. Many applications exist to edit these files,

diff --git a/docs/index-dev.rst b/docs/index-dev.rst
@@ -1,5 +1,5 @@
 ========================
-DFHack Development Guide
+DFHack development guide
 ========================
 
 These are pages relevant to people developing for DFHack.