Lint line length, clarify index#about,, README badges

README.md

@@ -1,4 +1,8 @@
 ## PeridexisErrant's DF Walkthrough
+[![Build Status](https://travis-ci.org/PeridexisErrant/DF-Walkthrough.svg)]
+(https://travis-ci.org/PeridexisErrant/DF-Walkthrough)
+[![Docs Status](https://readthedocs.org/projects/df-walkthrough/badge)]
+(https://df-walkthrough.rtfd.org)
 
 Resources for people who want to play Dwarf Fortress, but can't yet.
 
@@ -8,6 +12,6 @@ Resources for people who want to play Dwarf Fortress, but can't yet.
 
 [Check it out here!](https://df-walkthrough.readthedocs.org)
 
-If yuo're interested in contributing, I'd love a hand! The main priority is
+If you're interested in contributing, I'd love a hand! The main priority is
 updating the walkthrough and moving non-core content to tutorials.  More
 tutorials would also be great!

index.rst

@@ -8,17 +8,6 @@ than any other game around.  This walkthrough, along with the
 :forums:`DF Starter Pack <126076>`, are my attempts to dangle a rope
 down, as the community first did for me years ago.
 
-.. warning::
-
-    This is a work in progress - it's not all updated from the
-    old tutorials this is based on, so many references are to
-    an outdated version of the game.
-
-    The instructions are mostly still useful, but screenshots may
-    look a bit different.  I suggest playing with the DF Starter
-    Pack, rather than the old tutorial save, so your world is
-    compatible.
-
 
 The Walkthrough
 ===============
@@ -80,13 +69,15 @@ Other Information
 
 About
 =====
-This is a sucessor project to `TinyPirate's tutorials
+The source text and images are `hosted on Github
-<http://afteractionreporter.com/dwarf-fortress-tutorials/>`_,
+<https://github.com/PeridexisErrant/DF-Walkthrough>`_ and the finished site is
-with :reddit:`his approval <368j7h>` for adaptation, reuse, and relicensing.
+published immediately to `readthedocs.org <https://df-walkthrough.rtfd.org>`_
+every time a change is pushed.
 
-It **does not** use vanilla Dwarf Fortress - DF as distributed by ToadyOne
+Inspiration and original text - from which I learnt to play DF - by
-(the developer) - but embraces community mods, tools, and interface upgrades.
+`TinyPirate <http://afteractionreporter.com/dwarf-fortress-tutorials/>`_,
-If that's not your thing, try the guide :wiki:`on the wiki. <Quickstart_guide>`
+adapted with :reddit:`permission <368j7h>`.
 
-`Please consider supporting my work. <https://www.patreon.com/PeridexisErrant>`_
+Consider `supporting my work <https://www.patreon.com/PeridexisErrant>`_
+on Patreon.
 

misc/_static/dftext.css

@@ -1,9 +1,10 @@
-@import url("alabaster.css"); /* make sure to sync this with the base theme's css filename */
+/* make sure to sync this with the base theme's css filename */
+@import url("alabaster.css");
 
+.kbd {
 /* Keybinding CSS from the DF wiki; applies to :kbd:`` directives.
  * Use this directive for all keypresses, to make them look like keys.
  */
-.kbd {
     border: 1px solid #aaa;
     border-radius: 0.2em;
     -webkit-border-radius: 0.2em;

misc/lint.py

@@ -5,18 +5,18 @@ Any other automatic checks should be in this file too.
 """
 
 import os
+from os.path import *
 import sys
 
 text_extensions = ('rst', 'md', 'txt', 'html', 'css', 'js')
 
-
+def lint(path):
-def lint():
     """Run linters on all files, print problem files."""
     print('Checking for tabs or trailing whitespace...')
     failed = False
-    for root, _, files in os.walk('.'):
+    for root, _, files in os.walk(path):
         for f in files:
-            fname = os.path.join(root, f)
+            fname = join(root, f)
             if '_build' in fname or not any(
                     fname.endswith(ext) for ext in text_extensions):
                 continue
@@ -28,12 +28,20 @@ def lint():
                        for line in fh.readlines()):
                     failed = True
                     print('ERROR:  trailing whitespace in {}'.format(fname))
+                fh.seek(0)
+                for i, line in enumerate(fh.readlines()):
+                    if len(line) > 81:
+                        failed = True
+                        print('ERROR:  {}:{} - line too long'.format(
+                              fname, i + 1))
     if failed:
-        print('Use your text editor to convert tabs to spaces '
+        print('Use your text editor to convert tabs to spaces, wrap lines '
               'or trim trailing whitespace with minimal effort.')
         sys.exit(failed)
     print('All files are OK')
 
 
 if __name__ == '__main__':
-    lint()
+    # lint everything in the parent directory, wherever the script is run from.
+    p = relpath(join(dirname(__file__), '..'))
+    lint(p)

misc/what-is-df.rst

@@ -21,7 +21,8 @@ some of the better articles for a background understanding.
     Although Dwarf Fortress is still in a work in progress, many features
     have already been implemented...
 
-    -- `Tarn Adams (developer of *Dwarf Fortress*) <http://bay12games.com/dwarves/features.html>`_
+    -- `Tarn Adams (developer of *Dwarf Fortress*)
+       <http://bay12games.com/dwarves/features.html>`_
 
 
 .. epigraph::
@@ -55,7 +56,8 @@ some of the better articles for a background understanding.
     established one might be home to established communities of potential
     foes such as goblins.
 
-    -- `NewStatesman  <http://www.newstatesman.com/killing-time/2014/07/way-down-hole-getting-grips-dwarf-fortress>`_
+    -- `NewStatesman  <http://www.newstatesman.com/killing-time/2014/07/
+    way-down-hole-getting-grips-dwarf-fortress>`_
 
 
 .. epigraph::
@@ -74,5 +76,6 @@ some of the better articles for a background understanding.
     appreciate art) to the climate and economic patterns of the
     simulated world. ... 
     
-    -- `The NY Times Magazine <http://www.nytimes.com/2011/07/24/magazine/the-brilliance-of-dwarf-fortress.html?_r=2&pagewanted=all>`_
+    -- `The NY Times Magazine <http://www.nytimes.com/2011/07/24/magazine/
+    the-brilliance-of-dwarf-fortress.html?_r=2&pagewanted=all>`_
 

shortcut.html

@@ -9,6 +9,6 @@
         <title>Page Redirection</title>
     </head>
     <body>
-        <a href='./_build/html/index.html'>Follow this link to the real index page.</a>
+        <a href='./_build/html/index.html'>Follow this link to the index.</a>
     </body>
 </html>