diff --git a/Makefile b/Makefile index b92a88977..0b0fd61fe 100644 --- a/Makefile +++ b/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 diff --git a/doc/en/Makefile b/doc/en/Makefile index ce62f0ce6..e54b6b09a 100644 --- a/doc/en/Makefile +++ b/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 diff --git a/doc/en/adopt.txt b/doc/en/adopt.rst similarity index 100% rename from doc/en/adopt.txt rename to doc/en/adopt.rst diff --git a/doc/en/announce/index.txt b/doc/en/announce/index.rst similarity index 100% rename from doc/en/announce/index.txt rename to doc/en/announce/index.rst diff --git a/doc/en/announce/release-2.0.0.txt b/doc/en/announce/release-2.0.0.rst similarity index 100% rename from doc/en/announce/release-2.0.0.txt rename to doc/en/announce/release-2.0.0.rst diff --git a/doc/en/announce/release-2.0.1.txt b/doc/en/announce/release-2.0.1.rst similarity index 100% rename from doc/en/announce/release-2.0.1.txt rename to doc/en/announce/release-2.0.1.rst diff --git a/doc/en/announce/release-2.0.2.txt b/doc/en/announce/release-2.0.2.rst similarity index 100% rename from doc/en/announce/release-2.0.2.txt rename to doc/en/announce/release-2.0.2.rst diff --git a/doc/en/announce/release-2.0.3.txt b/doc/en/announce/release-2.0.3.rst similarity index 100% rename from doc/en/announce/release-2.0.3.txt rename to doc/en/announce/release-2.0.3.rst diff --git a/doc/en/announce/release-2.1.0.txt b/doc/en/announce/release-2.1.0.rst similarity index 100% rename from doc/en/announce/release-2.1.0.txt rename to doc/en/announce/release-2.1.0.rst diff --git a/doc/en/announce/release-2.1.1.txt b/doc/en/announce/release-2.1.1.rst similarity index 100% rename from doc/en/announce/release-2.1.1.txt rename to doc/en/announce/release-2.1.1.rst diff --git a/doc/en/announce/release-2.1.2.txt b/doc/en/announce/release-2.1.2.rst similarity index 100% rename from doc/en/announce/release-2.1.2.txt rename to doc/en/announce/release-2.1.2.rst diff --git a/doc/en/announce/release-2.1.3.txt b/doc/en/announce/release-2.1.3.rst similarity index 100% rename from doc/en/announce/release-2.1.3.txt rename to doc/en/announce/release-2.1.3.rst diff --git a/doc/en/announce/release-2.2.0.txt b/doc/en/announce/release-2.2.0.rst similarity index 100% rename from doc/en/announce/release-2.2.0.txt rename to doc/en/announce/release-2.2.0.rst diff --git a/doc/en/announce/release-2.2.1.txt b/doc/en/announce/release-2.2.1.rst similarity index 100% rename from doc/en/announce/release-2.2.1.txt rename to doc/en/announce/release-2.2.1.rst diff --git a/doc/en/announce/release-2.2.2.txt b/doc/en/announce/release-2.2.2.rst similarity index 100% rename from doc/en/announce/release-2.2.2.txt rename to doc/en/announce/release-2.2.2.rst diff --git a/doc/en/announce/release-2.2.4.txt b/doc/en/announce/release-2.2.4.rst similarity index 100% rename from doc/en/announce/release-2.2.4.txt rename to doc/en/announce/release-2.2.4.rst diff --git a/doc/en/announce/release-2.3.0.txt b/doc/en/announce/release-2.3.0.rst similarity index 100% rename from doc/en/announce/release-2.3.0.txt rename to doc/en/announce/release-2.3.0.rst diff --git a/doc/en/announce/release-2.3.1.txt b/doc/en/announce/release-2.3.1.rst similarity index 100% rename from doc/en/announce/release-2.3.1.txt rename to doc/en/announce/release-2.3.1.rst diff --git a/doc/en/announce/release-2.3.2.txt b/doc/en/announce/release-2.3.2.rst similarity index 100% rename from doc/en/announce/release-2.3.2.txt rename to doc/en/announce/release-2.3.2.rst diff --git a/doc/en/announce/release-2.3.3.txt b/doc/en/announce/release-2.3.3.rst similarity index 100% rename from doc/en/announce/release-2.3.3.txt rename to doc/en/announce/release-2.3.3.rst diff --git a/doc/en/announce/release-2.3.4.txt b/doc/en/announce/release-2.3.4.rst similarity index 100% rename from doc/en/announce/release-2.3.4.txt rename to doc/en/announce/release-2.3.4.rst diff --git a/doc/en/announce/release-2.3.5.txt b/doc/en/announce/release-2.3.5.rst similarity index 100% rename from doc/en/announce/release-2.3.5.txt rename to doc/en/announce/release-2.3.5.rst diff --git a/doc/en/announce/release-2.4.0.txt b/doc/en/announce/release-2.4.0.rst similarity index 100% rename from doc/en/announce/release-2.4.0.txt rename to doc/en/announce/release-2.4.0.rst diff --git a/doc/en/announce/release-2.4.1.txt b/doc/en/announce/release-2.4.1.rst similarity index 100% rename from doc/en/announce/release-2.4.1.txt rename to doc/en/announce/release-2.4.1.rst diff --git a/doc/en/announce/release-2.4.2.txt b/doc/en/announce/release-2.4.2.rst similarity index 100% rename from doc/en/announce/release-2.4.2.txt rename to doc/en/announce/release-2.4.2.rst diff --git a/doc/en/announce/release-2.5.0.txt b/doc/en/announce/release-2.5.0.rst similarity index 100% rename from doc/en/announce/release-2.5.0.txt rename to doc/en/announce/release-2.5.0.rst diff --git a/doc/en/announce/release-2.5.1.txt b/doc/en/announce/release-2.5.1.rst similarity index 100% rename from doc/en/announce/release-2.5.1.txt rename to doc/en/announce/release-2.5.1.rst diff --git a/doc/en/announce/release-2.5.2.txt b/doc/en/announce/release-2.5.2.rst similarity index 100% rename from doc/en/announce/release-2.5.2.txt rename to doc/en/announce/release-2.5.2.rst diff --git a/doc/en/announce/release-2.6.0.txt b/doc/en/announce/release-2.6.0.rst similarity index 100% rename from doc/en/announce/release-2.6.0.txt rename to doc/en/announce/release-2.6.0.rst diff --git a/doc/en/announce/release-2.6.1.txt b/doc/en/announce/release-2.6.1.rst similarity index 100% rename from doc/en/announce/release-2.6.1.txt rename to doc/en/announce/release-2.6.1.rst diff --git a/doc/en/announce/release-2.6.2.txt b/doc/en/announce/release-2.6.2.rst similarity index 100% rename from doc/en/announce/release-2.6.2.txt rename to doc/en/announce/release-2.6.2.rst diff --git a/doc/en/announce/release-2.6.3.txt b/doc/en/announce/release-2.6.3.rst similarity index 100% rename from doc/en/announce/release-2.6.3.txt rename to doc/en/announce/release-2.6.3.rst diff --git a/doc/en/announce/release-2.7.0.txt b/doc/en/announce/release-2.7.0.rst similarity index 100% rename from doc/en/announce/release-2.7.0.txt rename to doc/en/announce/release-2.7.0.rst diff --git a/doc/en/announce/release-2.7.1.txt b/doc/en/announce/release-2.7.1.rst similarity index 100% rename from doc/en/announce/release-2.7.1.txt rename to doc/en/announce/release-2.7.1.rst diff --git a/doc/en/announce/release-2.7.2.txt b/doc/en/announce/release-2.7.2.rst similarity index 100% rename from doc/en/announce/release-2.7.2.txt rename to doc/en/announce/release-2.7.2.rst diff --git a/doc/en/apiref.rst b/doc/en/apiref.rst new file mode 100644 index 000000000..6b9a6a5e3 --- /dev/null +++ b/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 + diff --git a/doc/en/apiref.txt b/doc/en/apiref.txt deleted file mode 100644 index 5cf1c0d98..000000000 --- a/doc/en/apiref.txt +++ /dev/null @@ -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 - diff --git a/doc/en/assert.txt b/doc/en/assert.rst similarity index 100% rename from doc/en/assert.txt rename to doc/en/assert.rst diff --git a/doc/en/bash-completion.txt b/doc/en/bash-completion.rst similarity index 100% rename from doc/en/bash-completion.txt rename to doc/en/bash-completion.rst diff --git a/doc/en/builtin.txt b/doc/en/builtin.rst similarity index 100% rename from doc/en/builtin.txt rename to doc/en/builtin.rst diff --git a/doc/en/capture.txt b/doc/en/capture.rst similarity index 100% rename from doc/en/capture.txt rename to doc/en/capture.rst diff --git a/doc/en/changelog.txt b/doc/en/changelog.rst similarity index 100% rename from doc/en/changelog.txt rename to doc/en/changelog.rst diff --git a/doc/en/conf.py b/doc/en/conf.py index 3df505434..aca0442c5 100644 --- a/doc/en/conf.py +++ b/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', ] diff --git a/doc/en/contact.txt b/doc/en/contact.rst similarity index 100% rename from doc/en/contact.txt rename to doc/en/contact.rst diff --git a/doc/en/contents.txt b/doc/en/contents.rst similarity index 90% rename from doc/en/contents.txt rename to doc/en/contents.rst index 4a85d9cc0..dabfcbecb 100644 --- a/doc/en/contents.txt +++ b/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 diff --git a/doc/en/contributing.txt b/doc/en/contributing.rst similarity index 100% rename from doc/en/contributing.txt rename to doc/en/contributing.rst diff --git a/doc/en/customize.txt b/doc/en/customize.rst similarity index 100% rename from doc/en/customize.txt rename to doc/en/customize.rst diff --git a/doc/en/doctest.txt b/doc/en/doctest.rst similarity index 100% rename from doc/en/doctest.txt rename to doc/en/doctest.rst diff --git a/doc/en/example/attic.txt b/doc/en/example/attic.rst similarity index 100% rename from doc/en/example/attic.txt rename to doc/en/example/attic.rst diff --git a/doc/en/example/index.txt b/doc/en/example/index.rst similarity index 87% rename from doc/en/example/index.txt rename to doc/en/example/index.rst index eb02e6c69..363de5ab7 100644 --- a/doc/en/example/index.txt +++ b/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 diff --git a/doc/en/example/markers.txt b/doc/en/example/markers.rst similarity index 100% rename from doc/en/example/markers.txt rename to doc/en/example/markers.rst diff --git a/doc/en/example/nonpython.txt b/doc/en/example/nonpython.rst similarity index 100% rename from doc/en/example/nonpython.txt rename to doc/en/example/nonpython.rst diff --git a/doc/en/example/parametrize.txt b/doc/en/example/parametrize.rst similarity index 100% rename from doc/en/example/parametrize.txt rename to doc/en/example/parametrize.rst diff --git a/doc/en/example/pythoncollection.txt b/doc/en/example/pythoncollection.rst similarity index 100% rename from doc/en/example/pythoncollection.txt rename to doc/en/example/pythoncollection.rst diff --git a/doc/en/example/reportingdemo.txt b/doc/en/example/reportingdemo.rst similarity index 100% rename from doc/en/example/reportingdemo.txt rename to doc/en/example/reportingdemo.rst diff --git a/doc/en/example/simple.txt b/doc/en/example/simple.rst similarity index 100% rename from doc/en/example/simple.txt rename to doc/en/example/simple.rst diff --git a/doc/en/example/special.txt b/doc/en/example/special.rst similarity index 100% rename from doc/en/example/special.txt rename to doc/en/example/special.rst diff --git a/doc/en/faq.txt b/doc/en/faq.rst similarity index 100% rename from doc/en/faq.txt rename to doc/en/faq.rst diff --git a/doc/en/fixture.txt b/doc/en/fixture.rst similarity index 100% rename from doc/en/fixture.txt rename to doc/en/fixture.rst diff --git a/doc/en/funcarg_compare.txt b/doc/en/funcarg_compare.rst similarity index 100% rename from doc/en/funcarg_compare.txt rename to doc/en/funcarg_compare.rst diff --git a/doc/en/funcargs.txt b/doc/en/funcargs.rst similarity index 100% rename from doc/en/funcargs.txt rename to doc/en/funcargs.rst diff --git a/doc/en/getting-started.txt b/doc/en/getting-started.rst similarity index 100% rename from doc/en/getting-started.txt rename to doc/en/getting-started.rst diff --git a/doc/en/goodpractises.txt b/doc/en/goodpractises.rst similarity index 99% rename from doc/en/goodpractises.txt rename to doc/en/goodpractises.rst index 54b71f62d..675ac6a9f 100644 --- a/doc/en/goodpractises.txt +++ b/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 diff --git a/doc/en/index.txt b/doc/en/index.rst similarity index 100% rename from doc/en/index.txt rename to doc/en/index.rst diff --git a/doc/en/mark.txt b/doc/en/mark.rst similarity index 100% rename from doc/en/mark.txt rename to doc/en/mark.rst diff --git a/doc/en/monkeypatch.txt b/doc/en/monkeypatch.rst similarity index 100% rename from doc/en/monkeypatch.txt rename to doc/en/monkeypatch.rst diff --git a/doc/en/naming20.txt b/doc/en/naming20.rst similarity index 100% rename from doc/en/naming20.txt rename to doc/en/naming20.rst diff --git a/doc/en/nose.txt b/doc/en/nose.rst similarity index 100% rename from doc/en/nose.txt rename to doc/en/nose.rst diff --git a/doc/en/overview.txt b/doc/en/overview.rst similarity index 61% rename from doc/en/overview.txt rename to doc/en/overview.rst index 321d79d8c..b0003effb 100644 --- a/doc/en/overview.txt +++ b/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 diff --git a/doc/en/parametrize.txt b/doc/en/parametrize.rst similarity index 100% rename from doc/en/parametrize.txt rename to doc/en/parametrize.rst diff --git a/doc/en/plugins.txt b/doc/en/plugins.rst similarity index 100% rename from doc/en/plugins.txt rename to doc/en/plugins.rst diff --git a/doc/en/plugins_index/index.txt b/doc/en/plugins_index/index.rst similarity index 100% rename from doc/en/plugins_index/index.txt rename to doc/en/plugins_index/index.rst diff --git a/doc/en/projects.txt b/doc/en/projects.rst similarity index 100% rename from doc/en/projects.txt rename to doc/en/projects.rst diff --git a/doc/en/recwarn.txt b/doc/en/recwarn.rst similarity index 100% rename from doc/en/recwarn.txt rename to doc/en/recwarn.rst diff --git a/doc/en/setup.txt b/doc/en/setup.rst similarity index 100% rename from doc/en/setup.txt rename to doc/en/setup.rst diff --git a/doc/en/skipping.txt b/doc/en/skipping.rst similarity index 100% rename from doc/en/skipping.txt rename to doc/en/skipping.rst diff --git a/doc/en/status.txt b/doc/en/status.rst similarity index 100% rename from doc/en/status.txt rename to doc/en/status.rst diff --git a/doc/en/talks.txt b/doc/en/talks.rst similarity index 100% rename from doc/en/talks.txt rename to doc/en/talks.rst diff --git a/doc/en/test/attic.txt b/doc/en/test/attic.rst similarity index 100% rename from doc/en/test/attic.txt rename to doc/en/test/attic.rst diff --git a/doc/en/test/index.txt b/doc/en/test/index.rst similarity index 100% rename from doc/en/test/index.txt rename to doc/en/test/index.rst diff --git a/doc/en/test/mission.txt b/doc/en/test/mission.rst similarity index 100% rename from doc/en/test/mission.txt rename to doc/en/test/mission.rst diff --git a/doc/en/test/plugin/cov.txt b/doc/en/test/plugin/cov.rst similarity index 100% rename from doc/en/test/plugin/cov.txt rename to doc/en/test/plugin/cov.rst diff --git a/doc/en/test/plugin/coverage.txt b/doc/en/test/plugin/coverage.rst similarity index 100% rename from doc/en/test/plugin/coverage.txt rename to doc/en/test/plugin/coverage.rst diff --git a/doc/en/test/plugin/django.txt b/doc/en/test/plugin/django.rst similarity index 100% rename from doc/en/test/plugin/django.txt rename to doc/en/test/plugin/django.rst diff --git a/doc/en/test/plugin/figleaf.txt b/doc/en/test/plugin/figleaf.rst similarity index 100% rename from doc/en/test/plugin/figleaf.txt rename to doc/en/test/plugin/figleaf.rst diff --git a/doc/en/test/plugin/genscript.txt b/doc/en/test/plugin/genscript.rst similarity index 100% rename from doc/en/test/plugin/genscript.txt rename to doc/en/test/plugin/genscript.rst diff --git a/doc/en/test/plugin/helpconfig.txt b/doc/en/test/plugin/helpconfig.rst similarity index 100% rename from doc/en/test/plugin/helpconfig.txt rename to doc/en/test/plugin/helpconfig.rst diff --git a/doc/en/test/plugin/index.txt b/doc/en/test/plugin/index.rst similarity index 100% rename from doc/en/test/plugin/index.txt rename to doc/en/test/plugin/index.rst diff --git a/doc/en/test/plugin/links.txt b/doc/en/test/plugin/links.rst similarity index 100% rename from doc/en/test/plugin/links.txt rename to doc/en/test/plugin/links.rst diff --git a/doc/en/test/plugin/nose.txt b/doc/en/test/plugin/nose.rst similarity index 100% rename from doc/en/test/plugin/nose.txt rename to doc/en/test/plugin/nose.rst diff --git a/doc/en/test/plugin/oejskit.txt b/doc/en/test/plugin/oejskit.rst similarity index 100% rename from doc/en/test/plugin/oejskit.txt rename to doc/en/test/plugin/oejskit.rst diff --git a/doc/en/test/plugin/terminal.txt b/doc/en/test/plugin/terminal.rst similarity index 100% rename from doc/en/test/plugin/terminal.txt rename to doc/en/test/plugin/terminal.rst diff --git a/doc/en/test/plugin/xdist.txt b/doc/en/test/plugin/xdist.rst similarity index 100% rename from doc/en/test/plugin/xdist.txt rename to doc/en/test/plugin/xdist.rst diff --git a/doc/en/tmpdir.txt b/doc/en/tmpdir.rst similarity index 100% rename from doc/en/tmpdir.txt rename to doc/en/tmpdir.rst diff --git a/doc/en/unittest.txt b/doc/en/unittest.rst similarity index 100% rename from doc/en/unittest.txt rename to doc/en/unittest.rst diff --git a/doc/en/usage.txt b/doc/en/usage.rst similarity index 100% rename from doc/en/usage.txt rename to doc/en/usage.rst diff --git a/doc/en/writing_plugins.txt b/doc/en/writing_plugins.rst similarity index 100% rename from doc/en/writing_plugins.txt rename to doc/en/writing_plugins.rst diff --git a/doc/en/xdist.txt b/doc/en/xdist.rst similarity index 100% rename from doc/en/xdist.txt rename to doc/en/xdist.rst diff --git a/doc/en/xunit_setup.txt b/doc/en/xunit_setup.rst similarity index 100% rename from doc/en/xunit_setup.txt rename to doc/en/xunit_setup.rst diff --git a/doc/en/yieldfixture.txt b/doc/en/yieldfixture.rst similarity index 100% rename from doc/en/yieldfixture.txt rename to doc/en/yieldfixture.rst