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

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.
develop
PeridexisErrant 2015-09-23 11:03:26 +10:00
parent 9d1baac6a0
commit 5ba656bf79
3 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.rst
Unescape Escape View File

@ -28,7 +28,7 @@ DFHack documentation is generated by Sphinx. Check out the table of contents
below, or the sources in the docs folder! below, or the sources in the docs folder!
Contents for users: User Manual:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -37,7 +37,16 @@ Contents for users:
docs/Plugins docs/Plugins
docs/Scripts docs/Scripts
Contents for developers: Other Contents:
.. toctree::
:maxdepth: 1
docs/Authors
docs/Licenses
docs/Changelog
For Developers:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -45,4 +54,3 @@ Contents for developers:
docs/Contributing docs/Contributing
docs/Compile docs/Compile
docs/Lua API docs/Lua API
docs/Authors

6
docs/Changelog.rst
Unescape Escape View File

@ -0,0 +1,6 @@
#########
Changelog
#########
.. include:: ../NEWS
:literal:

10
docs/Licenses.rst
Unescape Escape View File

@ -0,0 +1,10 @@
########
Licenses
########
DFHack is distributed under a range of permissive and weakly copyleft licenses.
The core uses the ZLib license; the others are described below.
.. include:: ../LICENSE
:literal: