Merge pull request #915 from Akasurde/issue-890

Converted docs from txt to rst

AUTHORS

@@ -3,6 +3,7 @@ merlinux GmbH, Germany, office at merlinux eu
 
 Contributors include::
 
+Abhijeet Kasurde
 Anatoly Bubenkoff
 Andreas Zeidler
 Andy Freeland

CHANGELOG

@@ -120,6 +120,8 @@
 
 - add ``file`` and ``line`` attributes to JUnit-XML output.
 
+- converted all txt documentation to rst format.
+
 2.7.3 (compared to 2.7.2)
 -----------------------------
 

Makefile

@@ -21,11 +21,11 @@ clean:
 
 # generate documentation
 docs: develop
-	find doc/en -name '*.txt' -not -path 'doc/en/_build/*' | xargs .env/bin/regendoc ${REGENDOC_ARGS}
+	find doc/en -name '*.rst' -not -path 'doc/en/_build/*' | xargs .env/bin/regendoc ${REGENDOC_ARGS}
 	cd doc/en; make html
 
 # upload documentation
 upload-docs: develop
-	find doc/en -name '*.txt' -not -path 'doc/en/_build/*' | xargs .env/bin/regendoc ${REGENDOC_ARGS} --update
+	find doc/en -name '*.rst' -not -path 'doc/en/_build/*' | xargs .env/bin/regendoc ${REGENDOC_ARGS} --update
 	#cd doc/en; make install
 

doc/en/Makefile

@@ -46,7 +46,7 @@ installall: clean install installpdf
 	@echo "done"
 
 regen:
-	PYTHONDONTWRITEBYTECODE=1 COLUMNS=76 regendoc --update *.txt */*.txt
+	PYTHONDONTWRITEBYTECODE=1 COLUMNS=76 regendoc --update *.rst */*.rst
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

doc/en/apiref.rst

@@ -0,0 +1,27 @@
+
+.. _apiref:
+
+pytest reference documentation
+================================================
+
+.. toctree::
+   :maxdepth: 2
+
+   builtin
+   customize
+   assert
+   fixture
+   yieldfixture
+   parametrize
+   xunit_setup
+   capture
+   monkeypatch
+   xdist
+   tmpdir
+   mark
+   skipping
+   recwarn
+   unittest
+   nose
+   doctest
+

doc/en/apiref.txt

@@ -1,27 +0,0 @@
-
-.. _apiref:
-
-pytest reference documentation
-================================================
-
-.. toctree::
-   :maxdepth: 2
-
-   builtin.txt
-   customize.txt
-   assert.txt
-   fixture.txt
-   yieldfixture.txt
-   parametrize.txt
-   xunit_setup.txt
-   capture.txt
-   monkeypatch.txt
-   xdist.txt
-   tmpdir.txt
-   mark.txt
-   skipping.txt
-   recwarn.txt
-   unittest.txt
-   nose.txt
-   doctest.txt
-

doc/en/conf.py

@@ -47,7 +47,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.autosummary',
 templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.txt'
+source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'
@@ -73,13 +73,13 @@ copyright = u'2015, holger krekel and pytest-dev team'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['links.inc', '_build', 'naming20.txt', 'test/*',
+exclude_patterns = ['links.inc', '_build', 'naming20.rst', 'test/*',
     "old_*",
     '*attic*',
     '*/attic*',
-    'funcargs.txt',
-    'setup.txt',
-    'example/remoteinterp.txt',
+    'funcargs.rst',
+    'setup.rst',
+    'example/remoteinterp.rst',
     ]
 
 

doc/en/contents.rst

@@ -17,11 +17,11 @@ Full pytest documentation
    example/index
    talks
    contributing
-   funcarg_compare.txt
+   funcarg_compare
    announce/index
 
 .. toctree::
    :hidden:
 
-   changelog.txt
+   changelog
 

doc/en/example/index.rst

@@ -25,10 +25,10 @@ The following examples aim at various use cases you might encounter.
 .. toctree::
    :maxdepth: 2
 
-   reportingdemo.txt
-   simple.txt
-   parametrize.txt
-   markers.txt
-   special.txt
-   pythoncollection.txt
-   nonpython.txt
+   reportingdemo
+   simple
+   parametrize
+   markers
+   special
+   pythoncollection
+   nonpython

doc/en/goodpractises.rst

@@ -155,7 +155,7 @@ to create a JUnitXML file that Jenkins_ can pick up and generate reports.
 .. _`genscript method`:
 
 (deprecated) Create a pytest standalone script
--------------------------------------------
+-----------------------------------------------
 
 If you are a maintainer or application developer and want people
 who don't deal with python much to easily run tests you may generate

doc/en/overview.rst

@@ -5,10 +5,10 @@ Getting started basics
 .. toctree::
    :maxdepth: 2
 
-   index.txt
-   getting-started.txt
-   usage.txt
-   goodpractises.txt
-   projects.txt
-   faq.txt
+   index
+   getting-started
+   usage
+   goodpractises
+   projects
+   faq