Misc changes for better structure

.gitignore

@@ -16,11 +16,13 @@ library/private/config.h
 
 # any build folders
 build*/
-_build/*
 nix
 buntu
 build/VC2010
 
+# Sphinx generated documentation
+docs/_*/
+
 #except for the real one
 !build/
 

.travis.yml

@@ -3,20 +3,18 @@ addons:
   apt:
     packages:
     - lua5.2
-#    - python3-docutils
 language: cpp
 env:
   matrix:
     -LUA_VERSION=5.2
 before_install:
 #- sudo apt-get install lua$LUA_VERSION
-#- sudo pip install docutils
+  pip install --user sphinx
-  pip install --user docutils
 script:
 - python travis/pr-check-base.py
 - python travis/lint.py
 - python travis/script-syntax.py --ext=lua --cmd="luac$LUA_VERSION -p"
 - python travis/script-syntax.py --ext=rb --cmd="ruby -c"
-- ./fixTexts.sh --force
+- make html
 notifications:
     email: false

Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = docs/_build
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

README.rst

@@ -1,14 +1,19 @@
 Welcome to DFHack's documentation!
 ==================================
 
-Contents:
+Contents for users:
 
 .. toctree::
    :maxdepth: 2
 
    docs/Readme
+
+Contents for developers:
+
+.. toctree::
+   :maxdepth: 1
+
    docs/Contributing
-   docs/Contributors
    docs/Compile
    docs/Lua API
-
+   docs/Authors

conf.py

@@ -33,7 +33,7 @@ import shlex
 extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = []
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -75,7 +75,7 @@ language = None
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['docs/_build']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -138,7 +138,7 @@ html_theme = 'alabaster'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

make-docs.bat

@@ -5,7 +5,7 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set BUILDDIR=_build
+set BUILDDIR=docs\_build
 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
 set I18NSPHINXOPTS=%SPHINXOPTS% .
 if NOT "%PAPER%" == "" (