diff --git a/docs/Authors.rst b/docs/Authors.rst index 2369d393d..280594674 100644 --- 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 index 85ec50344..0f3880816 100644 --- 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 index 09ae2577d..e03a7fcba 100644 --- 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 `. -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 `. .. _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 index 4109a81c7..13ae58dca 100644 --- 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 index ad24f8f43..d90983d8c 100644 --- 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 index de741f66a..6f276cdb6 100644 --- 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 index 1fe03e9a8..6afa9d6d4 100644 --- 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 index 74f94c20b..bcb7c77ec 100644 --- 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 ` folder contains ready-to-use diff --git a/docs/guides/quickfort-alias-guide.rst b/docs/guides/quickfort-alias-guide.rst index d4be8aecd..50e5d7650 100644 --- 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 index de5409ab3..86c82ac60 100644 --- 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 ` - :source:`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 index 9c7d3ed44..693ab033c 100644 --- 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 ` 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 index 5a03cbedf..0e3e673d3 100644 --- a/docs/index-dev.rst +++ b/docs/index-dev.rst @@ -1,4 +1,4 @@ -======================== + ======================== DFHack Development Guide ========================