Merge pull request #21 from michaeljoseph/cleanup-docs

Cleanup docs

CONTRIBUTING.md

@@ -9,7 +9,7 @@ You can contribute in many ways:
 
 ### Report Bugs
 
-Report bugs at <https://github.com/>michaeljoseph/mould/issues.
+Report bugs at <https://github.com/michaeljoseph/mould/issues>.
 
 If you are reporting a bug, please include:
 
@@ -30,14 +30,13 @@ Look through the GitHub issues for features. Anything tagged with
 
 ### Write Documentation
 
-A mould to create cookiecutters could always use more documentation,
-whether as part of the official A mould to create cookiecutters docs,
-in docstrings, or even on the web in blog posts, articles, and such.
+We could always use more documentation, whether as part of the official
+mould docs, in docstrings, or even on the web in blog posts and articles.
 
 ### Submit Feedback
 
 The best way to send feedback is to file an issue at
-<https://github.com/>michaeljoseph/mould/issues.
+<https://github.com/michaeljoseph/mould/issues>.
 
 If you are proposing a feature:
 
@@ -49,33 +48,32 @@ If you are proposing a feature:
 
 ## Documentation
 
-[API Documentation][(http://mould.rtfd.org)]
+[API Documentation][(https://mould.readthedocs.io)]
 
-## Testing
+## Development Setup
 
 Install development requirements:
 
     pip install -r requirements.txt
 
 Tests can then be run with:
 
-    nosetests
+    pytest
 
 Lint the project with:
 
-    flake8 changes tests
+    flake8 mould tests setup.py
 
 ## API documentation
 
 Generate the documentation with:
 
-    cd docs && PYTHONPATH=.. make singlehtml
+    make -C docs html
 
-To monitor changes to Python files and execute flake8 and nosetests
-automatically, execute the following from the root project directory:
-
-    stir
+To monitor changes to Python files and execute the tests
+automatically, use [pytest-watch](https://github.com/joeyespo/pytest-watch):
 
+    ptw
 
 ## Pull Request Guidelines
 
@@ -84,7 +82,6 @@ Before you submit a pull request, check that it meets these guidelines:
 1.  The pull request should include tests.
 2.  If the pull request adds functionality, the docs should be updated.
     Put your new functionality into a function with a docstring, and add
-    the feature to the list in README.rst.
-3.  The pull request should work for Python 2.6, 2.7, and 3.3, and for
-    PyPy. Check <https://travis-ci.org/>michaeljoseph/mould/pulls and make sure that
-    the tests pass for all supported Python versions.
+    the feature to the list in README.md.
+3.  Check <https://travis-ci.org/michaeljoseph/mould/pull_requests> and make sure that
+    the tests pass for all supported Python versions.

README.md

@@ -1,57 +1,47 @@
-mould
-=====
-
-Create cookiecutter templates from an existing project or module
-=======
 # mould
 
 [![Build Status](https://secure.travis-ci.org/michaeljoseph/mould.png)](http://travis-ci.org/michaeljoseph/mould)
-[![Stories in Ready](https://badge.waffle.io/michaeljoseph/mould.png?label=ready)](https://waffle.io/michaeljoseph/mould) [![pypi version](https://badge.fury.io/py/mould.png)](http://badge.fury.io/py/mould)
-[![# of downloads](https://pypip.in/d/mould/badge.png)](https://crate.io/packages/mould?version=latest)
-[![code coverage](https://coveralls.io/repos/michaeljoseph/mould/badge.png?branch=master)](https://coveralls.io/r/michaeljoseph/mould?branch=master)
+[![code coverage](https://codecov.io/gh/michaeljoseph/mould/branch/master/graph/badge.svg)](https://codecov.io/gh/michaeljoseph/mould)
 
 ## Overview
 
-Create cookiecutter templates from aisting directory
-
-* features
-* and stuff 
+Create [cookiecutter](https://github.com/audreyr/cookiecutter) templates from an existing project or module.
 
 ## Usage
 
 Install `mould`:
 
     pip install mould
 
-Then execute the sample cli:
+Then execute the cli:
 
    mould
 
 ## Documentation
 
-[API Documentation](http://mould.rtfd.org)
+[API Documentation](https://mould.readthedocs.io)
 
 ## Testing
 
-Install development requirements:
+Install the development requirements:
 
     pip install -r requirements.txt
 
-Tests can then be run with:
+Run the tests:
 
-    nosetests
+    pytest
 
-Lint the project with:
+Lint the project:
 
-    flake8 mould tests
+    flake8 mould tests setup.py
 
 ## API documentation
 
 Generate the documentation with:
 
-    cd docs && PYTHONPATH=.. make singlehtml
+    make -C docs html
 
-To monitor changes to Python files and execute flake8 and nosetests
-automatically, execute the following from the root project directory:
+To monitor changes to Python files and execute the tests
+automatically, use [pytest-watch](https://github.com/joeyespo/pytest-watch):
 
-    stir
+    ptw

docs/conf.py

@@ -137,7 +137,7 @@
 # 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 = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

docs/index.rst

@@ -1,7 +1,15 @@
 mould
-===============================
+=====
+
+.. toctree::
+   :maxdepth: 2
 
 .. automodule:: mould
     :members:
     :undoc-members:
     :show-inheritance:
+
+.. automodule:: mould.read
+    :members:
+    :undoc-members:
+    :show-inheritance:

mould/__init__.py

@@ -8,4 +8,4 @@
 __url__ = 'https://github.com/michaeljoseph/mould'
 __version__ = '0.0.1'
 
-__all__ = [read_directory, replace_directory_entries, write_directory]
+__all__ = ['read_directory', 'replace_directory_entries', 'write_directory']