MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dfhack/index.rst

66 lines
1.8 KiB
ReStructuredText
Raw Normal View History Unescape Escape

Split GitHub README from Sphinx index The root of the documentation tree has a different function to the short readme we want to display on GitHub, which now links to the main docs (or Bay12 thread, or IRC). It also renders properly on GitHub, and can use live-updating status badges because we don't expect it to work offline.
2015-10-27 17:06:28 -06:00
##################################
Standard basic sphinx setup
2015-09-22 01:42:15 -06:00
Welcome to DFHack's documentation!
Split GitHub README from Sphinx index The root of the documentation tree has a different function to the short readme we want to display on GitHub, which now links to the main docs (or Bay12 thread, or IRC). It also renders properly on GitHub, and can use live-updating status badges because we don't expect it to work offline.
2015-10-27 17:06:28 -06:00
##################################
Standard basic sphinx setup
2015-09-22 01:42:15 -06:00
Split readme into files for scripts, plugins, and base The plugin docs are still a mess, but the base and scripts are now close to manageable.
2015-09-22 07:30:22 -06:00
Introduction
============
Clean up other docs to match Some deduplication in Scripts and Plugins, links in NEWS, add content and link to files in index.
2015-11-05 06:59:48 -07:00
DFHack is a Dwarf Fortress memory access library, distributed with
a wide variety of useful scripts and plugins.
The project is currently hosted at https://www.github.com/DFHack/dfhack,
and can be downloaded from `the releases page
<http://github.com/DFHack/dfhack/releases>`_.
All new releases are announced in :forums:`the bay12 forums thread <139553>`,
which is also a good place for discussion and questions.
Split readme into files for scripts, plugins, and base The plugin docs are still a mess, but the base and scripts are now close to manageable.
2015-09-22 07:30:22 -06:00
For users, it provides a significant suite of bugfixes and interface
enhancements by default, and more can be enabled. There are also many tools
Use command name only for internal hyperlinks Because it's not actually that important to the user how a command is implemented, and the docs should reflect that. This also makes them easier to write!
2015-10-18 21:16:19 -06:00
(such as `workflow` or `autodump`) which can make life easier.
More consistent formatting Eg use of monospaced font, line length, internal links, added xml SYNTAX to root table of contents.
2015-09-24 04:17:58 -06:00
You can even add third-party scripts and plugins to do almost anything!
Split readme into files for scripts, plugins, and base The plugin docs are still a mess, but the base and scripts are now close to manageable.
2015-09-22 07:30:22 -06:00
For modders, DFHack makes many things possible. Custom reactions, new
Use command name only for internal hyperlinks Because it's not actually that important to the user how a command is implemented, and the docs should reflect that. This also makes them easier to write!
2015-10-18 21:16:19 -06:00
interactions, magic creature abilities, and more can be set through `modtools`
Split readme into files for scripts, plugins, and base The plugin docs are still a mess, but the base and scripts are now close to manageable.
2015-09-22 07:30:22 -06:00
and custom raws. Non-standard DFHack scripts and inits can be stored in the
raw directory, making raws or saves fully self-contained for distribution -
or for coexistence in a single DF install, even with incompatible components.
For developers, DFHack unites the various ways tools access DF memory and
allows easier development of new tools. As an open-source project under
Format LICENSE - minimal content changes No changes whatsoever are made to the licenses. Formatting is consistent. Comments are cleaned up a little. Some quotation marks are consistent. Added link target and links.
2015-09-24 04:19:51 -06:00
`various copyleft licences <license>`, contributions are welcome.
Split readme into files for scripts, plugins, and base The plugin docs are still a mess, but the base and scripts are now close to manageable.
2015-09-22 07:30:22 -06:00
Split GitHub README from Sphinx index The root of the documentation tree has a different function to the short readme we want to display on GitHub, which now links to the main docs (or Bay12 thread, or IRC). It also renders properly on GitHub, and can use live-updating status badges because we don't expect it to work offline.
2015-10-27 17:06:28 -06:00
User Manual
===========
Standard basic sphinx setup
2015-09-22 01:42:15 -06:00
.. toctree::
:maxdepth: 2
Fix compile, intro, scripts - script-syntax.py now exits with 1 instead of silently catching the error if lua or ruby are missing - index paths are absolute (from the repo root) - less strong suggestion for third-party packs - re-added lua-example and test-perlin doc - corrected and clarified Compile some more
2015-11-05 22:58:58 -07:00
/docs/Introduction
/docs/Core
/docs/Plugins
/docs/Scripts
Misc changes for better structure
2015-09-22 02:42:15 -06:00
Split GitHub README from Sphinx index The root of the documentation tree has a different function to the short readme we want to display on GitHub, which now links to the main docs (or Bay12 thread, or IRC). It also renders properly on GitHub, and can use live-updating status badges because we don't expect it to work offline.
2015-10-27 17:06:28 -06:00
Other Contents
==============
Include changelog and licenses in generated docs We may want to use .rst formatting for these eventually, and maybe move the NEWS file to docs/News.rst and docs/History.rst - but for now including the raw text works well enough.
2015-09-22 19:03:26 -06:00
.. toctree::
:maxdepth: 1
Fix compile, intro, scripts - script-syntax.py now exits with 1 instead of silently catching the error if lua or ruby are missing - index paths are absolute (from the repo root) - less strong suggestion for third-party packs - re-added lua-example and test-perlin doc - corrected and clarified Compile some more
2015-11-05 22:58:58 -07:00
/docs/Authors
/LICENSE
/NEWS
Include changelog and licenses in generated docs We may want to use .rst formatting for these eventually, and maybe move the NEWS file to docs/News.rst and docs/History.rst - but for now including the raw text works well enough.
2015-09-22 19:03:26 -06:00
Split GitHub README from Sphinx index The root of the documentation tree has a different function to the short readme we want to display on GitHub, which now links to the main docs (or Bay12 thread, or IRC). It also renders properly on GitHub, and can use live-updating status badges because we don't expect it to work offline.
2015-10-27 17:06:28 -06:00
For Developers
==============
Misc changes for better structure
2015-09-22 02:42:15 -06:00
.. toctree::
:maxdepth: 1
Fix compile, intro, scripts - script-syntax.py now exits with 1 instead of silently catching the error if lua or ruby are missing - index paths are absolute (from the repo root) - less strong suggestion for third-party packs - re-added lua-example and test-perlin doc - corrected and clarified Compile some more
2015-11-05 22:58:58 -07:00
/docs/Contributing
/docs/Compile
/docs/Lua API
/library/xml/SYNTAX
/library/xml/how-to-update
/docs/Binpatches