Skip to content

Commit

Permalink
move dev docs into dev dir
Browse files Browse the repository at this point in the history
  • Loading branch information
myk002 committed Nov 30, 2022
1 parent 64ce255 commit e952957
Show file tree
Hide file tree
Showing 18 changed files with 31 additions and 31 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/about/NEWS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
====================
DFHack API reference
====================
===================
DFHack API concepts
===================

.. toctree::
:maxdepth: 1
Expand Down
2 changes: 1 addition & 1 deletion docs/Binpatches.rst → docs/dev/Binpatches.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/Lua API.rst → docs/dev/Lua API.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
21 changes: 21 additions & 0 deletions docs/dev/index.rst
Original file line number Diff line number Diff line change
@@ -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
File renamed without changes.
3 changes: 1 addition & 2 deletions docs/guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
20 changes: 0 additions & 20 deletions docs/index-dev.rst

This file was deleted.

2 changes: 1 addition & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ User Manual
/docs/Core
/docs/Tools
/docs/guides/index
/docs/index-dev
/docs/dev/index
/docs/about/index

0 comments on commit e952957

Please sign in to comment.