Documentation tweaks

- Improve link in Binpatches.rst
- Fix `alias` anchor in Core.rst (ref #701)
- Increase depth of Plugins.rst table of contents. Some plugins were hard to
  find because they fit in multiple categories.
develop
lethosor 2017-06-23 12:44:34 -04:00
parent bf8e65311b
commit 789fc6dde0
3 changed files with 9 additions and 6 deletions

@ -13,15 +13,14 @@ the `binpatch` command.
We recommend using a script or plugin instead of a raw patch if We recommend using a script or plugin instead of a raw patch if
at all possible - that way your work will work for many versions at all possible - that way your work will work for many versions
across multiple operating systems. There's a reason nobody has across multiple operating systems.
written patches since ``0.34.11``!
.. contents:: .. contents::
Getting a patch Getting a patch
=============== ===============
There are no binary patches available for Dwarf Fortress versions after 0.34.11 There are no binary patches available for Dwarf Fortress versions after 0.34.11.
This system is kept for the chance that someone will find it useful, so some This system is kept for the chance that someone will find it useful, so some
hints on how to write your own follow. This will require disassembly and hints on how to write your own follow. This will require disassembly and
@ -29,7 +28,7 @@ decent skill in `memory research <contributing-memory-research>`.
* The patches are expected to be encoded in text format used by IDA. * The patches are expected to be encoded in text format used by IDA.
* See :commit:`8a9e3d1a728` for examples. * See `the patches folder in commit b0e1b51 <https://github.com/DFHack/dfhack/tree/b0e1b51d2ac08dd8c914f6ec299c5b355525a9aa/patches/>`_ for examples.
* :issue:`546` is about the future of the binpatches, and may be useful reading. * :issue:`546` is about the future of the binpatches, and may be useful reading.

@ -104,7 +104,8 @@ of DFhack, rather than plugins or scripts.
.. contents:: .. contents::
:local: :local:
.. _cls:
.. _alias:
alias alias
----- -----
@ -129,6 +130,9 @@ be passed to the underlying command in order. An example with `devel/print-args`
example example
text text
.. _cls:
cls cls
--- ---
Clear the terminal. Does not delete command history. Clear the terminal. Does not delete command history.

@ -10,7 +10,7 @@ Most commands offered by plugins are listed here,
hopefully organised in a way you will find useful. hopefully organised in a way you will find useful.
.. contents:: .. contents::
:depth: 2 :depth: 3
=============================== ===============================
Data inspection and visualizers Data inspection and visualizers