Change form rst to md docs files, delete some empty docs

oldani · Jun 4, 2017 · 6f4be4b · 6f4be4b
1 parent 4c22fed
commit 6f4be4b
Show file tree

Hide file tree

Showing 13 changed files with 111 additions and 161 deletions.
diff --git a/AUTHORS.rst → AUTHORS.md b/AUTHORS.rst → AUTHORS.md
@@ -1,13 +1,11 @@
-=======
-Credits
-=======
+# Credits
 
-Development Lead
-----------------
+
+## Development Lead
 
 * Ordanis Sanchez Suero <[email protected]>
 
-Contributors
-------------
+
+## Contributors
 
 None yet. Why not be the first?
diff --git a/CONTRIBUTING.rst → CONTRIBUTING.md b/CONTRIBUTING.rst → CONTRIBUTING.md
@@ -1,51 +1,43 @@
-.. highlight:: shell
+# Contributing
 
-============
-Contributing
-============
 
 Contributions are welcome, and they are greatly appreciated! Every
 little bit helps, and credit will always be given.
 
 You can contribute in many ways:
 
-Types of Contributions
-----------------------
+## Types of Contributions
 
-Report Bugs
-~~~~~~~~~~~
 
-Report bugs at https://github.com/oldani/HtmlTestRunner/issues.
+#### Report Bugs
+
+Report bugs [here](https://github.com/oldani/HtmlTestRunner/issues).
 
 If you are reporting a bug, please include:
 
 * Your operating system name and version.
 * Any details about your local setup that might be helpful in troubleshooting.
 * Detailed steps to reproduce the bug.
 
-Fix Bugs
-~~~~~~~~
+#### Fix Bugs
 
 Look through the GitHub issues for bugs. Anything tagged with "bug"
 and "help wanted" is open to whoever wants to implement it.
 
-Implement Features
-~~~~~~~~~~~~~~~~~~
+#### Implement Features
 
 Look through the GitHub issues for features. Anything tagged with "enhancement"
 and "help wanted" is open to whoever wants to implement it.
 
-Write Documentation
-~~~~~~~~~~~~~~~~~~~
+#### Write Documentation
 
 HtmlTestRunner could always use more documentation, whether as part of the
 official HtmlTestRunner docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
-Submit Feedback
-~~~~~~~~~~~~~~~
+#### Submit Feedback
 
-The best way to send feedback is to file an issue at https://github.com/oldani/HtmlTestRunner/issues.
+The best way to send feedback is to file an [issue](https://github.com/oldani/HtmlTestRunner/issues).
 
 If you are proposing a feature:
 
@@ -54,61 +46,60 @@ If you are proposing a feature:
 * Remember that this is a volunteer-driven project, and that contributions
   are welcome :)
 
-Get Started!
-------------
+## Get Started!
+
 
 Ready to contribute? Here's how to set up `HtmlTestRunner` for local development.
 
 1. Fork the `HtmlTestRunner` repo on GitHub.
-2. Clone your fork locally::
+2. Clone your fork locally:
 
-    $ git clone [email protected]:your_name_here/HtmlTestRunner.git
+        $ git clone [email protected]:your_name_here/HtmlTestRunner.git
 
-3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
 
-    $ mkvirtualenv HtmlTestRunner
-    $ cd HtmlTestRunner/
-    $ python setup.py develop
+        $ mkvirtualenv HtmlTestRunner
+        $ cd HtmlTestRunner/
+        $ pip install -r requirements_dev.txt
+        $ python setup.py develop
 
-4. Create a branch for local development::
+4. Create a branch for local development:
 
-    $ git checkout -b name-of-your-bugfix-or-feature
+        $ git checkout -b name-of-your-bugfix-or-feature
 
-   Now you can make your changes locally.
+    Now you can make your changes locally.
 
 5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
 
-    $ flake8 HtmlTestRunner tests
-    $ python setup.py test or py.test
-    $ tox
-
-   To get flake8 and tox, just pip install them into your virtualenv.
+        $ flake8 HtmlTestRunner tests
+        $ python setup.py test or py.test
+        $ tox
 
 6. Commit your changes and push your branch to GitHub::
 
-    $ git add .
-    $ git commit -m "Your detailed description of your changes."
-    $ git push origin name-of-your-bugfix-or-feature
+        $ git add .
+        $ git commit -m "Your detailed description of your changes."
+        $ git push origin name-of-your-bugfix-or-feature
 
 7. Submit a pull request through the GitHub website.
 
-Pull Request Guidelines
------------------------
+
+## Pull Request Guidelines
+
 
 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, 3.3, 3.4 and 3.5, and for PyPy. Check
-   https://travis-ci.org/oldani/HtmlTestRunner/pull_requests
+2. If the pull request adds functionality, the docs should be updated. All
+   functions should have docstrings.
+3. The pull request should work for Python 2.7 and 3.5. Check 
+   [Travis test](https://travis-ci.org/oldani/HtmlTestRunner/pull_requests)
    and make sure that the tests pass for all supported Python versions.
 
-Tips
-----
-
-To run a subset of tests::
+## Tips
 
 
+To run a subset of tests::
+```bash
     $ python -m unittest tests.test_HtmlTestRunner
+```
diff --git a/HISTORY.md b/HISTORY.md
@@ -0,0 +1,18 @@
+# History
+
+
+## 1 (2017-01-28)
+
+* First release on PyPI.
+
+## 1.0.1 (2017-01-29)
+
+* Rename package due to conflict in PyPI.
+
+## 1.0.2 (2017-01-29)
+
+* Fix broken docs.
+
+## 1.0.3 (2017-01-29)
+
+* Fix bug with the template not beign include in the package.
diff --git a/HISTORY.rst b/HISTORY.rst
diff --git a/README.md b/README.md
@@ -24,6 +24,7 @@ incorporated code from both projects but up to date.
 - [Console Output](#console-output)
 - [Test Results](#test-result)
 - [Todo](#todo)
+- [Contributing](#contributing)
 - [Credits](#credits)
 
 ## Installation
@@ -129,6 +130,13 @@ This is a sample of the template that came by default with the runner. If you wa
 - [ ] Add xml results
 - [ ] Add support for Python2.7
 
+## Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+For more info please click [here](./CONTRIBUTING.md)
+
 ## Credits
 
 This package was created with Cookiecutter and the `audreyr/cookiecutter-pypackage` project template.

diff --git a/docs/authors.rst b/docs/authors.rst
diff --git a/docs/contributing.rst b/docs/contributing.rst
diff --git a/docs/history.rst b/docs/history.rst
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/installation.md b/docs/installation.md
@@ -0,0 +1,41 @@
+# Installation
+
+
+## Stable release
+
+
+To install HtmlTestRunner, run this command in your terminal:
+
+```batch
+
+    $ pip install html-testRunner
+```
+
+This is the preferred method to install HtmlTestRunner, as it will always install the most recent stable release. If you don't have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide
+you through the process.
+
+
+# From sources
+
+The sources for HtmlTestRunner can be downloaded from the [Github repo](https://github.com/oldani/HtmlTestRunner).
+
+You can either clone the public repository:
+
+```batch
+
+    $ git clone git://github.com/oldani/HtmlTestRunner
+```
+
+Or download the [tarball](https://github.com/oldani/HtmlTestRunner/tarball/master):
+
+```batch
+
+    $ curl  -OL https://github.com/oldani/HtmlTestRunner/tarball/master
+```
+
+Once you have a copy of the source, you can install it with:
+
+```batch
+
+    $ python setup.py install
+```
diff --git a/docs/installation.rst b/docs/installation.rst
diff --git a/docs/readme.rst b/docs/readme.rst
diff --git a/docs/usage.rst b/docs/usage.rst