Replace all .rst with .md

Author: audreyfeldroy

docs/troubleshooting.md

@@ -1,6 +1,6 @@
 # Troubleshooting
 
-> **Note:** Can you help improve this file? [Edit this file](https://github.com/audreyfeldroy/cookiecutter-pypackage/blob/master/docs/troubleshooting.rst) and submit a pull request with your improvements!
+> **Note:** Can you help improve this file? [Edit this file](https://github.com/audreyfeldroy/cookiecutter-pypackage/blob/master/docs/troubleshooting.md) and submit a pull request with your improvements!
 
 ## Windows Issues
 

docs/tutorial.md

@@ -1,6 +1,6 @@
 # Tutorial
 
-> **Note:** Did you find any of these instructions confusing? [Edit this file](https://github.com/audreyfeldroy/cookiecutter-pypackage/blob/master/docs/tutorial.rst) and submit a pull request with your improvements!
+> **Note:** Did you find any of these instructions confusing? [Edit this file](https://github.com/audreyfeldroy/cookiecutter-pypackage/blob/master/docs/tutorial.md) and submit a pull request with your improvements!
 
 To start with, you will need a [GitHub account](https://github.com/) and an account on [PyPI](https://pypi.python.org/pypi). Create these before you get started on this tutorial. If you are new to Git and GitHub, you should probably spend a few minutes on some of the tutorials at the top of the page at [GitHub Help](https://help.github.com/).
 

hooks/post_gen_project.py

@@ -3,5 +3,5 @@
 
 if __name__ == "__main__":
     if "{{ cookiecutter.create_author_file }}" != "y":
-        pathlib.Path("AUTHORS.rst").unlink()
-        pathlib.Path("docs", "authors.rst").unlink()
+        pathlib.Path("AUTHORS.md").unlink()
+        pathlib.Path("docs", "authors.md").unlink()

tests/test_bake_project.py

@@ -108,19 +108,19 @@ def test_bake_with_apostrophe_and_run_tests(cookies):
 def test_bake_without_author_file(cookies):
     with bake_in_temp_dir(cookies, extra_context={"create_author_file": "n"}) as result:
         found_toplevel_files = [f.basename for f in result.project.listdir()]
-        assert "AUTHORS.rst" not in found_toplevel_files
+        assert "AUTHORS.md" not in found_toplevel_files
         doc_files = [f.basename for f in result.project.join("docs").listdir()]
-        assert "authors.rst" not in doc_files
+        assert "authors.md" not in doc_files
 
         # Assert there are no spaces in the toc tree
-        docs_index_path = result.project.join("docs/index.rst")
+        docs_index_path = result.project.join("docs/index.md")
         with open(str(docs_index_path)) as index_file:
             assert "contributing\n   history" in index_file.read()
 
         # Check that
         manifest_path = result.project.join("MANIFEST.in")
         with open(str(manifest_path)) as manifest_file:
-            assert "AUTHORS.rst" not in manifest_file.read()
+            assert "AUTHORS.md" not in manifest_file.read()
 
 
 def test_make_help(cookies):
@@ -154,7 +154,7 @@ def test_bake_not_open_source(cookies):
         found_toplevel_files = [f.basename for f in result.project.listdir()]
         assert "pyproject.toml" in found_toplevel_files
         assert "LICENSE" not in found_toplevel_files
-        assert "License" not in result.project.join("README.rst").read()
+        assert "License" not in result.project.join("README.md").read()
 
 
 def test_using_pytest(cookies):

{{cookiecutter.project_slug}}/MANIFEST.in

@@ -1,13 +1,13 @@
 {% if cookiecutter.create_author_file == 'y' -%}
-include AUTHORS.rst
+include AUTHORS.md
 {% endif -%}
-include CONTRIBUTING.rst
-include HISTORY.rst
+include CONTRIBUTING.md
+include HISTORY.md
 include LICENSE
-include README.rst
+include README.md
 
 recursive-include tests *
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
 
-recursive-include docs *.rst Makefile make.bat *.jpg *.png *.gif
+recursive-include docs *.md Makefile make.bat *.jpg *.png *.gif

{{cookiecutter.project_slug}}/Makefile

@@ -67,15 +67,15 @@ coverage: ## check code coverage quickly with the default Python
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/{{ cookiecutter.project_slug }}.rst
-	rm -f docs/modules.rst
+	rm -f docs/{{ cookiecutter.project_slug }}.md
+	rm -f docs/modules.md
 	sphinx-apidoc -o docs/ {{ cookiecutter.project_slug }}
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html
 
 servedocs: docs ## compile the docs watching for changes
-	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
+	watchmedo shell-command -p '*.md' -c '$(MAKE) -C docs html' -R -D .
 
 release: dist ## package and upload a release
 	twine upload dist/*

{{cookiecutter.project_slug}}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "{{cookiecutter.project_slug}}"
 description = "{{cookiecutter.project_short_description}}"
-readme = "README.rst"
+readme = "README.md"
 authors = [
   {name = "{{cookiecutter.full_name}}", email = "{{cookiecutter.email}}"}
 ]