From e952957f91c925216eba8335f9d0cbdc4b0844c8 Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Wed, 30 Nov 2022 03:59:26 -0800 Subject: [PATCH] move dev docs into dev dir --- docs/{ => about}/History.rst | 0 docs/about/NEWS.rst | 2 +- docs/api/index.rst | 6 +++--- docs/{ => dev}/Binpatches.rst | 2 +- docs/{ => dev}/Compile.rst | 0 docs/{ => dev}/Contributing.rst | 0 docs/{ => dev}/Dev-intro.rst | 0 docs/{ => dev}/Documentation.rst | 0 docs/{ => dev}/Lua API.rst | 6 +++--- docs/{ => dev}/Memory-research.rst | 0 docs/{ => dev}/NEWS-dev.rst | 0 docs/{ => dev}/Remote.rst | 0 docs/{ => dev}/Structures-intro.rst | 0 docs/dev/index.rst | 21 +++++++++++++++++++++ docs/{guides => dev}/overlay-dev-guide.rst | 0 docs/guides/index.rst | 3 +-- docs/index-dev.rst | 20 -------------------- index.rst | 2 +- 18 files changed, 31 insertions(+), 31 deletions(-) rename docs/{ => about}/History.rst (100%) rename docs/{ => dev}/Binpatches.rst (99%) rename docs/{ => dev}/Compile.rst (100%) rename docs/{ => dev}/Contributing.rst (100%) rename docs/{ => dev}/Dev-intro.rst (100%) rename docs/{ => dev}/Documentation.rst (100%) rename docs/{ => dev}/Lua API.rst (99%) rename docs/{ => dev}/Memory-research.rst (100%) rename docs/{ => dev}/NEWS-dev.rst (100%) rename docs/{ => dev}/Remote.rst (100%) rename docs/{ => dev}/Structures-intro.rst (100%) create mode 100644 docs/dev/index.rst rename docs/{guides => dev}/overlay-dev-guide.rst (100%) delete mode 100644 docs/index-dev.rst diff --git a/docs/History.rst b/docs/about/History.rst similarity index 100% rename from docs/History.rst rename to docs/about/History.rst diff --git a/docs/about/NEWS.rst b/docs/about/NEWS.rst index 13d5e38de..41e64b339 100644 --- a/docs/about/NEWS.rst +++ b/docs/about/NEWS.rst @@ -24,4 +24,4 @@ Older Changelogs ================ Are kept in a separate file: `History` -.. that's ``docs/History.rst``, if you're reading the raw text. +.. that's ``docs/about/History.rst``, if you're reading the raw text. diff --git a/docs/api/index.rst b/docs/api/index.rst index 6afa9d6d4..e0748be2c 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -1,6 +1,6 @@ -==================== -DFHack API reference -==================== +=================== +DFHack API concepts +=================== .. toctree:: :maxdepth: 1 diff --git a/docs/Binpatches.rst b/docs/dev/Binpatches.rst similarity index 99% rename from docs/Binpatches.rst rename to docs/dev/Binpatches.rst index 5c1c640d4..a56657616 100644 --- a/docs/Binpatches.rst +++ b/docs/dev/Binpatches.rst @@ -155,7 +155,7 @@ gui/assign-rack Bind to a key (the example config uses :kbd:`P`), and activate when viewing a weapon rack in the :kbd:`q` mode. -.. image:: images/assign-rack.png +.. image:: /docs/images/assign-rack.png This script is part of a group of related fixes to make the armory storage work again. The existing issues are: diff --git a/docs/Compile.rst b/docs/dev/Compile.rst similarity index 100% rename from docs/Compile.rst rename to docs/dev/Compile.rst diff --git a/docs/Contributing.rst b/docs/dev/Contributing.rst similarity index 100% rename from docs/Contributing.rst rename to docs/dev/Contributing.rst diff --git a/docs/Dev-intro.rst b/docs/dev/Dev-intro.rst similarity index 100% rename from docs/Dev-intro.rst rename to docs/dev/Dev-intro.rst diff --git a/docs/Documentation.rst b/docs/dev/Documentation.rst similarity index 100% rename from docs/Documentation.rst rename to docs/dev/Documentation.rst diff --git a/docs/Lua API.rst b/docs/dev/Lua API.rst similarity index 99% rename from docs/Lua API.rst rename to docs/dev/Lua API.rst index 8ba7429fa..37865394e 100644 --- a/docs/Lua API.rst +++ b/docs/dev/Lua API.rst @@ -2,9 +2,9 @@ .. _lua-api: -############## -DFHack Lua API -############## +######################## +DFHack Lua API Reference +######################## DFHack has extensive support for the Lua_ scripting language, providing access to: diff --git a/docs/Memory-research.rst b/docs/dev/Memory-research.rst similarity index 100% rename from docs/Memory-research.rst rename to docs/dev/Memory-research.rst diff --git a/docs/NEWS-dev.rst b/docs/dev/NEWS-dev.rst similarity index 100% rename from docs/NEWS-dev.rst rename to docs/dev/NEWS-dev.rst diff --git a/docs/Remote.rst b/docs/dev/Remote.rst similarity index 100% rename from docs/Remote.rst rename to docs/dev/Remote.rst diff --git a/docs/Structures-intro.rst b/docs/dev/Structures-intro.rst similarity index 100% rename from docs/Structures-intro.rst rename to docs/dev/Structures-intro.rst diff --git a/docs/dev/index.rst b/docs/dev/index.rst new file mode 100644 index 000000000..d88b4b425 --- /dev/null +++ b/docs/dev/index.rst @@ -0,0 +1,21 @@ +======================== +DFHack development guide +======================== + +These are pages relevant to people developing for DFHack. + +.. toctree:: + :maxdepth: 1 + + /docs/dev/Dev-intro + /docs/dev/Compile + /docs/dev/Contributing + /docs/dev/Documentation + /docs/api/index + /docs/dev/Lua API + /docs/dev/overlay-dev-guide + /docs/dev/Structures-intro + /docs/dev/Memory-research + /docs/dev/Binpatches + /docs/dev/Remote + /docs/dev/NEWS-dev diff --git a/docs/guides/overlay-dev-guide.rst b/docs/dev/overlay-dev-guide.rst similarity index 100% rename from docs/guides/overlay-dev-guide.rst rename to docs/dev/overlay-dev-guide.rst diff --git a/docs/guides/index.rst b/docs/guides/index.rst index a3d9a0482..95f9ff32a 100644 --- a/docs/guides/index.rst +++ b/docs/guides/index.rst @@ -7,9 +7,8 @@ These pages are detailed guides covering DFHack tools. .. toctree:: :maxdepth: 1 - /docs/guides/examples-guide - /docs/guides/overlay-dev-guide /docs/guides/modding-guide + /docs/guides/examples-guide /docs/guides/quickfort-library-guide /docs/guides/quickfort-user-guide /docs/guides/quickfort-alias-guide diff --git a/docs/index-dev.rst b/docs/index-dev.rst deleted file mode 100644 index 38c458bfe..000000000 --- a/docs/index-dev.rst +++ /dev/null @@ -1,20 +0,0 @@ -======================== -DFHack development guide -======================== - -These are pages relevant to people developing for DFHack. - -.. toctree:: - :maxdepth: 1 - - /docs/Dev-intro - /docs/Contributing - /docs/Compile - /docs/NEWS-dev - /docs/Lua API - /docs/Remote - /docs/api/index - /docs/Documentation - /docs/Structures-intro - /docs/Memory-research - /docs/Binpatches diff --git a/index.rst b/index.rst index 0e2c4431f..af0f76052 100644 --- a/index.rst +++ b/index.rst @@ -30,5 +30,5 @@ User Manual /docs/Core /docs/Tools /docs/guides/index - /docs/index-dev + /docs/dev/index /docs/about/index