From 5ba656bf79281153cca0ceeb2050dd4f4cf9dd0e Mon Sep 17 00:00:00 2001 From: PeridexisErrant Date: Wed, 23 Sep 2015 11:03:26 +1000 Subject: [PATCH] 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. --- README.rst | 14 +++++++++++--- docs/Changelog.rst | 6 ++++++ docs/Licenses.rst | 10 ++++++++++ 3 files changed, 27 insertions(+), 3 deletions(-) create mode 100644 docs/Changelog.rst create mode 100644 docs/Licenses.rst diff --git a/README.rst b/README.rst index 7d8830f45..79d778ec2 100644 --- a/README.rst +++ b/README.rst @@ -28,7 +28,7 @@ DFHack documentation is generated by Sphinx. Check out the table of contents below, or the sources in the docs folder! -Contents for users: +User Manual: .. toctree:: :maxdepth: 2 @@ -37,7 +37,16 @@ Contents for users: docs/Plugins docs/Scripts -Contents for developers: +Other Contents: + +.. toctree:: + :maxdepth: 1 + + docs/Authors + docs/Licenses + docs/Changelog + +For Developers: .. toctree:: :maxdepth: 1 @@ -45,4 +54,3 @@ Contents for developers: docs/Contributing docs/Compile docs/Lua API - docs/Authors diff --git a/docs/Changelog.rst b/docs/Changelog.rst new file mode 100644 index 000000000..6d6d27ec8 --- /dev/null +++ b/docs/Changelog.rst @@ -0,0 +1,6 @@ +######### +Changelog +######### + +.. include:: ../NEWS + :literal: diff --git a/docs/Licenses.rst b/docs/Licenses.rst new file mode 100644 index 000000000..0f7b41cb5 --- /dev/null +++ b/docs/Licenses.rst @@ -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: