Merge pull request #205 from jacebrowning/release/v1.0.1

Release v1.0.2

.gitattributes

@@ -1,5 +1,5 @@
 * text=auto
-CHANGES.md merge=union
+CHANGELOG.md merge=union
 
 *.xlsx binary
 

.gitignore

@@ -7,19 +7,21 @@ __pycache__
 # Temporary OS files
 Icon*
 
-# Temporary virtualenv files
+# Temporary virtual environment files
 .cache
-env
+/env
+
+# Temporary server files
+.env
+*.pid
 
 # Generated documentation
-docs/gen
-apidocs
+/docs/gen
+/apidocs
+/site
 /*.html
-*.rst
-docs/*.png
-docs/sphinx/_build
-pages/docs/
-pages/reqs/
+/*.rst
+/docs/*.png
 
 # Google Drive
 *.gdoc
@@ -28,13 +30,17 @@ pages/reqs/
 *.gdraw
 
 # Testing and coverage results
+.cache
+.pytest
 .coverage
-htmlcov
-pyunit.xml
+.coverage.*
+/htmlcov
+/pyunit.xml
+*.tmp
 
 # Build and release directories
-build
-dist
+/build
+/dist
 
 # Sublime Text
 *.sublime-workspace

.travis.yml

@@ -29,8 +29,8 @@ after_script: >
   echo $TRAVIS_BRANCH; echo $TRAVIS_PULL_REQUEST; echo $TRAVIS_PYTHON_VERSION;
   if [[ $TRAVIS_BRANCH == 'develop' && $TRAVIS_PULL_REQUEST == 'false' && $TRAVIS_PYTHON_VERSION == '3.3' ]]; then
 
-    # Generate Doorstop and Sphinx HTML pages
-    make pages ;
+    # Generate Doorstop HTML pages
+    make reqs ;
 
     # Configure Git with Travis CI information
     git config --global user.email "travis@travis-ci.org" ;
@@ -40,7 +40,7 @@ after_script: >
     rm -rf .git ;
 
     # Rebuild the repository from the generated files and push to GitHub pages
-    cd pages ;
+    cd docs/gen ;
     echo "[${TRAVIS_REPO_SLUG}](~${TRAVIS_REPO_SLUG})" | sed -e 's/\//.github.io\//g' | sed -e 's/~/http:\/\//g' > README.md ;
     touch .nojekyll ;
     git init ;

CHANGES.md → CHANGELOG.md

@@ -1,37 +1,34 @@
-Revision History
-================
+# Revision History
 
-1.0 (2016/04/17)
-----------------
+## 1.0.2 (2016/06/08)
+
+- Moved the documentation to [ReadTheDocs](http://doorstop.readthedocs.io).
+
+## 1.0 (2016/04/17)
 
 - Fixed a bug checking levels across inactive items.
 - Added error message for all IO errors.
 - Added '--skip' options to disable documents during validation.
 - Added Mercurial support. (credit: [@tjasz](https://github.com/tjasz))
 
-0.8.4 (2015/03/12)
-------------------
+## 0.8.4 (2015/03/12)
 
 - Restrict `openpyxl < 2.2` (there appears to be a breaking change).
 
-0.8.3 (2014/10/10)
-------------------
+## 0.8.3 (2014/10/10)
 
 - Fixed a bug running VCS commands in subdirectories.
 - Excluded `openpyxl == 2.1.0` as a dependency version.
 
-0.8.2 (2014/09/29)
-------------------
+## 0.8.2 (2014/09/29)
 
 - Limit the maximum version of `openpyxl` to 2.1.0 due to deprecation bug.
 
-0.8.1 (2014/09/04)
-------------------
+## 0.8.1 (2014/09/04)
 
 - Fixed a bug requesting new item numbers from the server.
 
-0.8 (2014/08/28)
-----------------
+## 0.8 (2014/08/28)
 
 - Added `doorstop clear ...` to absolve items of their suspect link status.
 - Added `doorstop review ...` to absolve items of their unreviewed status.
@@ -44,13 +41,11 @@ Revision History
 - Added '--server' argument to `doorstop add` to specify the server address.
 - Added '--warn-all' and '--error-all' options promote warnings to errors.
 
-0.7.1 (2014/08/18)
-------------------
+## 0.7.1 (2014/08/18)
 
 - Fixed bug importing items with empty attributes.
 
-0.7 (2014/07/08)
-----------------
+## 0.7 (2014/07/08)
 
 - Added `doorstop delete ...` to delete document directories.
 - Added `doorstop export ...` to export content for external tools.
@@ -64,8 +59,7 @@ Revision History
 - Renamed `doorstop new ...` to `doorstop create ...`.
 - Made 'all' a reserved word, which cannot be used as a prefix.
 
-0.6 (2014/05/15)
-----------------
+## 0.6 (2014/05/15)
 
 - Refactored `Item` levels into a `Level` class.
 - Refactored `Item` identifiers into an `ID` class.
@@ -81,8 +75,7 @@ Revision History
 - Added '--no-level-check' to disable document level validation.
 - Added '--reorder' option to `doorstop` to enable reordering.
 
-0.5 (2014/04/25)
-----------------
+## 0.5 (2014/04/25)
 
 - Converted `Item.issues()` to a property and added `Item.get_issues()`.
 - Added '--level' option to `doorstop add` to force an item level.
@@ -93,193 +86,143 @@ Revision History
 - Renamed `Tree` methods: new -> new_document, add -> add_item, remove -> remove_item, link -> link_items, unlink -> unlink_items, edit -> edit_item, valid -> validate.
 - Added `doorstop.importer` functions to add exiting documents and items.
 
-0.4.3 (2014/03/18)
-------------------
+## 0.4.3 (2014/03/18)
 
 - Fixed storage of 2-part levels ending in a multiple of 10.
 
-0.4.2 (2014/03/17)
-------------------
+## 0.4.2 (2014/03/17)
 
 - Fixed a case where `Item.root` was not set.
 
-0.4.1 (2014/03/16)
-------------------
+## 0.4.1 (2014/03/16)
 
 - Fixed auto save/load decorator order.
 
-0.4 (2014/03/16)
-----------------
+## 0.4 (2014/03/16)
 
 - Added `Tree.delete()` to delete all document directories and item files.
 - Added `doorstop publish all <directory>` to publish trees and `index.html`.
 
-0.3 (2014/03/12)
-----------------
+## 0.3 (2014/03/12)
 
 - Added find_document and find_item convenience functions.
 - Added `Document.delete()` to delete a document directory and its item files.
 
-0.2 (2014/03/05)
-----------------
+## 0.2 (2014/03/05)
 
 - All `Item` text attributes are now be split by sentences and line-wrapped.
 - Added `Tree.load()` for cases when lazy loading is too slow.
 - Added caching to `Tree.find_item()` and `Tree.find_document()`.
 
-
-0.1 (2014/02/17)
-----------------
+## 0.1 (2014/02/17)
 
 - Top-level items are no longer required to have a level ending in zero.
 - Added `Item/Document.extended` to get a list of extended attribute names.
 
-
-0.0.21 (2014/02/14)
--------------------
+## 0.0.21 (2014/02/14)
 
 - Documents can now have item files in sub-folders.
 
-
-0.0.20 (2014/02/13)
--------------------
+## 0.0.20 (2014/02/13)
 
 - Updated `doorstop.core.report` to support lists of items.
 
-
-0.0.19 (2014/02/13)
--------------------
+## 0.0.19 (2014/02/13)
 
 - Updated doorstop.core.report to support items or documents.
 - Removed the 'iter\_' prefix from all generators.
 
-
-0.0.18 (2014/02/12)
--------------------
+## 0.0.18 (2014/02/12)
 
 - Fixed CSS bullets indent.
 
-
-0.0.17 (2014/01/31)
--------------------
+## 0.0.17 (2014/01/31)
 
 - Added caching of `Item` in the `Document` class.
 - Added `Document.remove()` to delete an item by its ID.
 - `Item.find_rlinks()` will now search the entire tree for links.
 
-
-0.0.16 (2014/01/28)
--------------------
+## 0.0.16 (2014/01/28)
 
 - Added `Item.find_rlinks()` to return reverse links and child documents.
 - Changed the logging format.
 - Added a '--project' argument to provide a path to the root of the project.
 
-
-0.0.15 (2014/01/27)
--------------------
+## 0.0.15 (2014/01/27)
 
 - Fixed a mutable default argument bug in `Item` creation.
 
-
-0.0.14 (2014/01/27)
--------------------
+## 0.0.14 (2014/01/27)
 
 - Added `Tree/Document/Item.iter_issues()` method to yield all issues.
 - `Tree/Document/Item.check()` now logs all issues rather than failing fast.
 - Renamed `Tree/Document/Item.check()` to `valid()`.
 
-
-0.0.13 (2014/01/25)
--------------------
+## 0.0.13 (2014/01/25)
 
 - Added `Document.sep` to separate prefix and item numbers.
 
-
-0.0.12 (2014/01/24)
--------------------
+## 0.0.12 (2014/01/24)
 
 - Fixed missing package data.
 
-
-0.0.11 (2014/01/23)
--------------------
+## 0.0.11 (2014/01/23)
 
 - Added `Item.active` property to disable certain items.
 - Added `Item.derived` property to disable link checking on certain items.
 
-
-0.0.10 (2014/01/22)
--------------------
+## 0.0.10 (2014/01/22)
 
 - Switched to embedded CSS in generated HTML.
 - Shortened default `Item` and `Document` string formatting.
 
-
-0.0.9 (2014/01/21)
-------------------
+## 0.0.9 (2014/01/21)
 
 - Added top-down link checking.
 - Non-normative items with a zero-ended level are now headings.
 - Added a CSS for generated HTML.
 - The 'publish' command now accepts an output file path.
 
-
-0.0.8 (2014/01/16)
-------------------
+## 0.0.8 (2014/01/16)
 
 - Searching for 'ref' will now also find filenames.
 - Item files can now contain arbitrary fields.
 - Document prefixes can now contain numbers, dashes, and periods.
 - Added a 'normative' attribute to the Item class.
 
-
-0.0.7 (2013/12/09)
-------------------
+## 0.0.7 (2013/12/09)
 
 - Always showing 'ref' in items.
 - Reloading item attributes after a save.
 - Inserting lines breaks after sentences in item 'text'.
 
-
-0.0.6 (2013/12/04)
-------------------
+## 0.0.6 (2013/12/04)
 
 - Added basic report creation via `doorstop publish ...`.
 
-
-0.0.5 (2013/11/20)
-------------------
+## 0.0.5 (2013/11/20)
 
 - Added item link and reference validation.
 - Added cached of loaded items.
 - Added preliminary VCS support for Git and Veracity.
 
-
-0.0.4 (2013/11/04)
-------------------
+## 0.0.4 (2013/11/04)
 
 - Implemented `add`, `remove`, `link`, and `unlink` commands.
 - Added basic tree validation.
 
-
-0.0.3 (2013/10/17)
-------------------
+## 0.0.3 (2013/10/17)
 
 - Added the initial `Document` class.
 - Items can now be ordered by 'level' in a document.
 - Initial tutorial created.
 
-
-0.0.2 (2013/09/25)
-------------------
+## 0.0.2 (2013/09/25)
 
 - Changed `doorstop init` to `doorstop new`.
 - Added the initial `Item` class.
 - Added stubs for the `Document` class.
 
-
-0.0.1 (2013/09/11)
-------------------
+## 0.0.1 (2013/09/11)
 
 - Initial release of Doorstop.

LICENSE.txt → LICENSE.md

@@ -1,3 +1,6 @@
+# License
+
+```
                    GNU LESSER GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
@@ -163,3 +166,4 @@ whether future versions of the GNU Lesser General Public License shall
 apply, that proxy's public statement of acceptance of any version is
 permanent authorization for you to choose that version for the
 Library.
+```