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

Split GitHub README from Sphinx index 

The root of the documentation tree has a different function to the short
readme we want to display on GitHub, which now links to the main docs
(or Bay12 thread, or IRC).  It also renders properly on GitHub, and can
use live-updating status badges because we don't expect it to work
offline.
develop
PeridexisErrant 2015-10-28 10:06:28 +11:00
parent 4be9e13d74
commit 5efea525e0
5 changed files with 37 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CMakeLists.txt
Unescape Escape View File

@ -214,7 +214,7 @@ if (BUILD_DOCS)
"*.lua" "*.lua"
"*.rb" "*.rb"
) )
set(SPHINX_DEPS ${SPHINX_DEPS} ${SPHINX_SCRIPT_DEPS} LICENSE.rst NEWS.rst README.rst) set(SPHINX_DEPS ${SPHINX_DEPS} ${SPHINX_SCRIPT_DEPS} LICENSE.rst NEWS.rst index.rst)
set(SPHINX_OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/docs/html/.buildinfo") set(SPHINX_OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/docs/html/.buildinfo")
set_source_files_properties(${SPHINX_OUTPUT} PROPERTIES GENERATED TRUE) set_source_files_properties(${SPHINX_OUTPUT} PROPERTIES GENERATED TRUE)

6
README.html
Unescape Escape View File

@ -4,13 +4,13 @@
<html lang="en-US"> <html lang="en-US">
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta http-equiv="refresh" content="0;url=./docs/html/README.html"> <meta http-equiv="refresh" content="0;url=./docs/html/index.html">
<script type="text/javascript"> <script type="text/javascript">
window.location.href = "./docs/html/README.html" window.location.href = "./docs/html/index.html"
</script> </script>
<title>Page Redirection</title> <title>Page Redirection</title>
</head> </head>
<body> <body>
If you are not redirected automatically, follow the <a href='./docs/html/README.html'>link to the documentation.</a> Follow this <a href='./docs/html/index.html'>link to the documentation.</a>
</body> </body>
</html> </html>

24
README.md
Unescape Escape View File

@ -0,0 +1,24 @@
#DFHack Readme
[![Build Status](https://travis-ci.org/DFHack/dfhack.svg?branch=develop)]
(https://travis-ci.org/DFHack/dfhack)
[![Documentation Status](https://readthedocs.org/projects/dfhack/badge)]
(https://dfhack.readthedocs.org)
[![License](https://img.shields.io/badge/license-ZLib-blue.svg)]
(https://en.wikipedia.org/wiki/Zlib_License)
[![Github Issues](http://githubbadges.herokuapp.com/DFHack/dfhack/issues)]
(https://github.com/DFHack/dfhack/issues)
[![Open Pulls](http://githubbadges.herokuapp.com/DFHack/dfhack/pulls)]
(https://github.com/DFHack/dfhack/pulls)
DFHack is a Dwarf Fortress memory access library, distributed with scripts
and plugins implementing a wide variety of useful functions and tools.
The full documentation [is available online here](https://dfhack.readthedocs.org),
from the README.html page in the DFHack distribution, or as raw text in the `./docs` folder.
If you're an end-user, modder, or interested in contributing to DFHack -
go read those docs.
If that's unclear or you need more help, try [the Bay12 forums thread]
(http://www.bay12forums.com/smf/index.php?topic=139553) or the #dfhack IRC
channel on freenode.

2
docs/conf.py
Unescape Escape View File

@ -130,7 +130,7 @@ source_suffix = '.rst'
#source_encoding = 'utf-8-sig' #source_encoding = 'utf-8-sig'
# The master toctree document. # The master toctree document.
master_doc = 'README' master_doc = 'index'
# General information about the project. # General information about the project.
project = 'DFHack' project = 'DFHack'

19
README.rst → index.rst
Unescape Escape View File

@ -1,5 +1,6 @@
##################################
Welcome to DFHack's documentation! Welcome to DFHack's documentation!
================================== ##################################
Introduction Introduction
============ ============
@ -22,14 +23,8 @@ allows easier development of new tools. As an open-source project under
`various copyleft licences <license>`, contributions are welcome. `various copyleft licences <license>`, contributions are welcome.
Documentation User Manual
============= ===========
DFHack documentation is generated by Sphinx. Check out the table of contents
below, or the sources in the `docs folder`_!
.. _`docs folder`: ./docs
User Manual:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -38,7 +33,8 @@ User Manual:
docs/Plugins docs/Plugins
docs/Scripts docs/Scripts
Other Contents: Other Contents
==============
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -47,7 +43,8 @@ Other Contents:
LICENSE LICENSE
NEWS NEWS
For Developers: For Developers
==============
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1