Clean up configuration files

conf.py

@@ -27,8 +27,6 @@ import shlex
 # ones.
 extensions = [
     'sphinx.ext.extlinks',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -36,8 +34,7 @@ templates_path = []
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst']
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'
@@ -55,9 +52,9 @@ author = 'PeridexisErrant'
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = '0.2'
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = '0.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -71,10 +68,9 @@ language = None
 nitpicky = True
 
 # There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
+# non-false value, then it is used,
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+today_fmt = '%Y-%m-%d'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -127,7 +123,7 @@ html_style = 'dftext.css'
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+html_title = project
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
@@ -136,9 +132,7 @@ html_style = 'dftext.css'
 # of the sidebar.
 #html_logo = None
 
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
+# The name of an image file (within the static path) to use as the favicon
 html_favicon = 'misc/df-icon.ico'
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -162,10 +156,10 @@ html_last_updated_fmt = ''
 #html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+html_domain_indices = False
 
 # If false, no index is generated.
-#html_use_index = True
+html_use_index = False
 
 # If true, the index is split into individual pages for each letter.
 #html_split_index = False

index.rst

@@ -45,8 +45,7 @@ digging too deep, or learning to make and install mods.
 Each tutorial is a short, self-contained introduction to a topic which is
 likely to be of interest to players who have just finished the walkthrough.
 And if you're most interested in somthing not listed here,
-`dwarffortresswiki <http://dwarffortresswiki.org>`_
-and the Bay12 Forums will be your best friends.
+:wiki:`the wiki <>` and the Bay12 Forums will be your best friends.
 
 
 .. toctree::

misc/lint.py

@@ -5,13 +5,13 @@ Any other automatic checks should be in this file too.
 """
 
 from glob import glob
-from io import open
+import io
 import os
-from os.path import *
+from os.path import basename, dirname, join, relpath
 import sys
 
 text_extensions = ('rst', 'md', 'txt', 'html', 'css', 'js')
-dirs = ['chapters', 'tutorials', 'masterclass']
+DIRS = ['chapters', 'tutorials', 'masterclass']
 
 
 def error(fname, lineno, issue):
@@ -29,7 +29,7 @@ def lint(path):
             if '_build' in fname or not any(
                     fname.endswith(ext) for ext in text_extensions):
                 continue
-            with open(fname, encoding='utf-8') as fh:
+            with io.open(fname, encoding='utf-8') as fh:
                 for i, line in enumerate(fh.readlines()):
                     if len(line) > 81:
                         failed = True
@@ -49,20 +49,19 @@ def unused_images(path):
     """Check that all files in image subdirs are references in the text."""
     print('Checking for unused images...')
     failed = False
-    for d in dirs:
+    for d in DIRS:
         text = ''
-        for fname in glob(os.path.join(d, '*.rst')):
-            with open(fname, encoding='utf-8') as f:
+        for fname in glob(join(d, '*.rst')):
+            with io.open(fname, encoding='utf-8') as f:
                 text += f.read()
-        for img in glob(os.path.join(d, 'images', '*.*')):
-            img = os.path.basename(img)
+        for img in glob(join(d, 'images', '*.*')):
+            img = basename(img)
             if img == 'Thumbs.db':
                 continue
             markup = '.. image:: images/{}'.format(img)
             if markup not in text:
                 failed = True
-                print('Error:  image not referenced, {}/{}/{}'.format(
-                      d, 'images', img))
+                print('Error: not referenced: "{}/images/{}"'.format(d, img))
     if failed:
         print('Use or or delete these images.')
     return failed
@@ -71,6 +70,7 @@ def unused_images(path):
 if __name__ == '__main__':
     # lint everything in the parent directory, wherever the script is run from.
     p = relpath(join(dirname(__file__), '..'))
-    failed = lint(p)
-    failed |= unused_images(p)
-    sys.exit(failed)
+    fail_lint = lint(p)
+    fail_imgs = unused_images(p)
+    print('lint.py done.')
+    sys.exit(fail_lint or fail_imgs)