From 5826b49d09f12ebc16cc6937234b1e56aa39a559 Mon Sep 17 00:00:00 2001 From: PeridexisErrant Date: Fri, 6 Nov 2015 17:09:56 +1100 Subject: [PATCH] Move index.rst to docs directory Having the docs index in the repo root was a holdover from when it was the README file. Now that it's not much use without being built, it's better to leave the root to README, NEWS, and LICENSE - especially when one is a html shortcut to the docs index. --- CMakeLists.txt | 2 +- README.html | 6 +++--- conf.py | 2 +- index.rst => docs/index.rst | 0 4 files changed, 5 insertions(+), 5 deletions(-) rename index.rst => docs/index.rst (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index fb6dd52bb..c7ab44fd5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -214,7 +214,7 @@ if (BUILD_DOCS) "${CMAKE_CURRENT_SOURCE_DIR}/scripts/*.lua" "${CMAKE_CURRENT_SOURCE_DIR}/scripts/*.rb" ) - set(SPHINX_DEPS ${SPHINX_DEPS} ${SPHINX_SCRIPT_DEPS} LICENSE.rst NEWS.rst index.rst) + set(SPHINX_DEPS ${SPHINX_DEPS} ${SPHINX_SCRIPT_DEPS} LICENSE.rst NEWS.rst) set(SPHINX_OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/docs/html/.buildinfo") set_source_files_properties(${SPHINX_OUTPUT} PROPERTIES GENERATED TRUE) diff --git a/README.html b/README.html index 325cd66f6..660ea2b5b 100644 --- a/README.html +++ b/README.html @@ -4,13 +4,13 @@ - + Page Redirection - Follow this link to the documentation. + Follow this link to the documentation. \ No newline at end of file diff --git a/conf.py b/conf.py index 5eb2c8177..7b0a7c4c5 100644 --- a/conf.py +++ b/conf.py @@ -120,7 +120,7 @@ source_suffix = '.rst' #source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = 'docs/index' # General information about the project. project = 'DFHack' diff --git a/index.rst b/docs/index.rst similarity index 100% rename from index.rst rename to docs/index.rst