Set language of some code blocks to enable syntax highlighting

develop
lethosor 2020-10-09 01:15:42 -04:00
parent a5f85e256d
commit c2280356cb
No known key found for this signature in database
GPG Key ID: 76A269552F4F58C1
9 changed files with 34 additions and 10 deletions

@ -80,7 +80,9 @@ system console:
If you use a permanent patch under OSX or Linux, you must update If you use a permanent patch under OSX or Linux, you must update
``symbols.xml`` with the new checksum of the executable. Find the relevant ``symbols.xml`` with the new checksum of the executable. Find the relevant
section, and add a new line:: section, and add a new line:
.. code-block:: xml
<md5-hash value='????????????????????????????????'/> <md5-hash value='????????????????????????????????'/>

@ -1,3 +1,5 @@
.. highlight:: shell
.. _compile: .. _compile:
################ ################
@ -283,7 +285,9 @@ Dwarf Fortress runs, it uses a libstdc++ shipped in the ``libs`` folder, which
comes from GCC 4.8 and is incompatible with code compiled with newer GCC comes from GCC 4.8 and is incompatible with code compiled with newer GCC
versions. As of DFHack 0.42.05-alpha1, the ``dfhack`` launcher script attempts versions. As of DFHack 0.42.05-alpha1, the ``dfhack`` launcher script attempts
to fix this by automatically removing the DF-provided libstdc++ on startup. to fix this by automatically removing the DF-provided libstdc++ on startup.
In rare cases, this may fail and cause errors such as:: In rare cases, this may fail and cause errors such as:
.. code-block:: text
./libs/Dwarf_Fortress: /pathToDF/libs/libstdc++.so.6: version ./libs/Dwarf_Fortress: /pathToDF/libs/libstdc++.so.6: version
`GLIBCXX_3.4.18' not found (required by ./hack/libdfhack.so) `GLIBCXX_3.4.18' not found (required by ./hack/libdfhack.so)

@ -63,7 +63,9 @@ or at any other time using the ``dfhack-run`` executable.
If DF/DFHack is started with arguments beginning with ``+``, the remaining If DF/DFHack is started with arguments beginning with ``+``, the remaining
text is treated as a command in the DFHack console. It is possible to use text is treated as a command in the DFHack console. It is possible to use
multiple such commands, which are split on ``+``. For example:: multiple such commands, which are split on ``+``. For example:
.. code-block:: shell
./dfhack +load-save region1 ./dfhack +load-save region1
"Dwarf Fortress.exe" +devel/print-args Hello! +enable workflow "Dwarf Fortress.exe" +devel/print-args Hello! +enable workflow
@ -93,7 +95,9 @@ but ``dfhack-run`` can be useful in a variety of circumstances:
- from external programs or scripts - from external programs or scripts
- if DF or DFHack are not responding - if DF or DFHack are not responding
Examples:: Examples:
.. code-block:: shell
./dfhack-run cursecheck ./dfhack-run cursecheck
dfhack-run kill-lua dfhack-run kill-lua
@ -456,7 +460,9 @@ Environment variables
===================== =====================
DFHack's behavior can be adjusted with some environment variables. For example, DFHack's behavior can be adjusted with some environment variables. For example,
on UNIX-like systems:: on UNIX-like systems:
.. code-block:: shell
DFHACK_SOME_VAR=1 ./dfhack DFHACK_SOME_VAR=1 ./dfhack

@ -57,7 +57,9 @@ as the in-console documentation by (e.g.) printing it when a ``-help`` argument
is given. is given.
The docs **must** have a heading which exactly matches the command, underlined The docs **must** have a heading which exactly matches the command, underlined
with ``=====`` to the same length. For example, a lua file would have:: with ``=====`` to the same length. For example, a lua file would have:
.. code-block:: lua
local helpstr = [====[ local helpstr = [====[
@ -69,6 +71,8 @@ with ``=====`` to the same length. For example, a lua file would have::
]====] ]====]
.. highlight:: rst
Where the heading for a section is also the name of a command, the spelling Where the heading for a section is also the name of a command, the spelling
and case should exactly match the command to enter in the DFHack command line. and case should exactly match the command to enter in the DFHack command line.
@ -118,6 +122,8 @@ Scripts have link targets created automatically.
Building the documentation Building the documentation
========================== ==========================
.. highlight:: shell
Required dependencies Required dependencies
--------------------- ---------------------
In order to build the documentation, you must have Python with Sphinx In order to build the documentation, you must have Python with Sphinx

@ -1,3 +1,5 @@
.. highlight:: lua
.. _lua-api: .. _lua-api:
############## ##############

@ -119,7 +119,9 @@ GDB
`GDB <https://www.gnu.org/software/gdb/>`_ is technically cross-platform, but `GDB <https://www.gnu.org/software/gdb/>`_ is technically cross-platform, but
tends to work best on Linux, and DFHack currently only offers support for using tends to work best on Linux, and DFHack currently only offers support for using
GDB on 64-bit Linux. To start with GDB, pass ``-g`` to the DFHack launcher GDB on 64-bit Linux. To start with GDB, pass ``-g`` to the DFHack launcher
script:: script:
.. code-block:: shell
./dfhack -g ./dfhack -g

@ -1443,7 +1443,9 @@ can be displayed on the main fortress mode screen:
The file :file:`dfhack-config/dwarfmonitor.json` can be edited to control the The file :file:`dfhack-config/dwarfmonitor.json` can be edited to control the
positions and settings of all widgets displayed. This file should contain a positions and settings of all widgets displayed. This file should contain a
JSON object with the key ``widgets`` containing an array of objects - see the JSON object with the key ``widgets`` containing an array of objects - see the
included file in the ``dfhack-config`` folder for an example:: included file in the ``dfhack-config`` folder for an example:
.. code-block:: lua
{ {
"widgets": [ "widgets": [

@ -1 +1 @@
Subproject commit d8dab1b758f7e08fd6cf32e32c04d2389d95e158 Subproject commit 935b687ee65a7d5f470c0c86e50ef80634e1b884

@ -1 +1 @@
Subproject commit 4e6bfa81f89f93cd0c5abe2775a37ae5ffeaa3f7 Subproject commit a6d5df4e73f06b4f8a829baeca97f0d63830b65b