diff --git a/ci/authors-rst.py b/ci/authors-rst.py index 076f7f226..b9ef48d7c 100755 --- a/ci/authors-rst.py +++ b/ci/authors-rst.py @@ -11,9 +11,9 @@ def main(): info += ' %s %s:' % (k, kwargs[k]) print('line %i:%s %s' % (line, info, msg)) if os.environ.get('GITHUB_ACTIONS'): - print('::error file=docs/Authors.rst,line=%i::%s %s' % (line, info.lstrip(), msg)) + print('::error file=docs/about/Authors.rst,line=%i::%s %s' % (line, info.lstrip(), msg)) success[0] = False - with open('docs/Authors.rst', 'rb') as f: + with open('docs/about/Authors.rst', 'rb') as f: lines = list(map(lambda line: line.decode('utf8').replace('\n', ''), f.readlines())) if lines[1].startswith('='): diff --git a/ci/lint-ignore.txt b/ci/lint-ignore.txt index d384b80f3..c8c40c82b 100644 --- a/ci/lint-ignore.txt +++ b/ci/lint-ignore.txt @@ -10,9 +10,14 @@ plugins/stonesense/*.txt # Generated files *.pb.h build*/* -docs/_* +docs/changelogs/* docs/html/* docs/pdf/* +docs/pseudoxml/* +docs/tags/* +docs/text/* +docs/tools/* +docs/xml/* library/include/df/* # Dependencies that we don't control diff --git a/docs/NEWS.rst b/docs/NEWS.rst index 13d5e38de..41e64b339 100644 --- a/docs/NEWS.rst +++ b/docs/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/Authors.rst b/docs/about/Authors.rst similarity index 100% rename from docs/Authors.rst rename to docs/about/Authors.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/Removed.rst b/docs/about/Removed.rst similarity index 100% rename from docs/Removed.rst rename to docs/about/Removed.rst diff --git a/docs/index-about.rst b/docs/about/index.rst similarity index 77% rename from docs/index-about.rst rename to docs/about/index.rst index 3dba1e5f8..e8dede969 100644 --- a/docs/index-about.rst +++ b/docs/about/index.rst @@ -7,7 +7,7 @@ These pages contain information about the general DFHack project. .. toctree:: :maxdepth: 1 - /docs/NEWS - /docs/Authors + /docs/about/Authors /LICENSE - /docs/Removed + /docs/about/Removed + /docs/NEWS 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/changelog.txt b/docs/changelog.txt index eba204e64..3748134c1 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -1,7 +1,7 @@ === Scroll down for changes ===[[[ -The text below is included in docs/Documentation.rst - see that file for more details on the changelog setup. +The text below is included in docs/dev/Documentation.rst - see that file for more details on the changelog setup. This is kept in this file as a quick syntax reference. ===help 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 98% rename from docs/Contributing.rst rename to docs/dev/Contributing.rst index 799a420a5..f503d9126 100644 --- a/docs/Contributing.rst +++ b/docs/dev/Contributing.rst @@ -92,7 +92,7 @@ General contribution guidelines compiles. Our CI should catch anything that fails to build, but checking in advance can sometimes let you know of any issues sooner. * Update documentation when applicable - see `docs-standards` for details. -* Update ``changelog.txt`` and ``docs/Authors.rst`` when applicable. See +* Update ``docs/changelog.txt`` and ``docs/about/Authors.rst`` when applicable. See `build-changelog` for more information on the changelog format. * Submit ideas and bug reports as :issue:`issues on GitHub <>`. Posts in the forum thread can easily get missed or forgotten. 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/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..26d094ec8 --- /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/NEWS-dev diff --git a/docs/guides/overlay-dev-guide.rst b/docs/dev/overlay-dev-guide.rst similarity index 98% rename from docs/guides/overlay-dev-guide.rst rename to docs/dev/overlay-dev-guide.rst index 87d9dd49c..d7f651deb 100644 --- a/docs/guides/overlay-dev-guide.rst +++ b/docs/dev/overlay-dev-guide.rst @@ -16,17 +16,17 @@ screen. If you need very specific low-level control, those APIs might be the right choice for you. However, here are some reasons you might want to implement an overlay widget instead: -1. You can draw directly to an existing viewscreen instead of creating an +#. You can draw directly to an existing viewscreen instead of creating an entirely new screen on the viewscreen stack. This allows the original viewscreen to continue processing uninterrupted and keybindings bound to that viewscreen will continue to function. This was previously only achievable by C++ plugins. -1. You'll get a free UI for enabling/disabling your widget and repositioning it +#. You'll get a free UI for enabling/disabling your widget and repositioning it on the screen. Widget state is saved for you and is automatically restored when the game is restarted. -1. You don't have to manage the C++ interposing logic yourself and can focus on +#. You don't have to manage the C++ interposing logic yourself and can focus on the business logic, writing purely in Lua if desired. In general, if you are writing a plugin or script and have anything you'd like 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 a54ea87f5..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/index-about + /docs/dev/index + /docs/about/index