Converted documentation from txt to rst

This commit is contained in:
Abhijeet Kasurde 2015-08-05 10:18:52 +05:30
commit 6d446e7167
100 changed files with 51 additions and 51 deletions

View File

@ -21,11 +21,11 @@ clean:
# generate documentation # generate documentation
docs: develop 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 cd doc/en; make html
# upload documentation # upload documentation
upload-docs: develop 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 #cd doc/en; make install

View File

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

27
doc/en/apiref.rst Normal file
View File

@ -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

View File

@ -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

View File

@ -47,7 +47,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.autosummary',
templates_path = ['_templates'] templates_path = ['_templates']
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.txt' source_suffix = '.rst'
# The encoding of source files. # The encoding of source files.
#source_encoding = 'utf-8-sig' #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 # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # 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_*", "old_*",
'*attic*', '*attic*',
'*/attic*', '*/attic*',
'funcargs.txt', 'funcargs.rst',
'setup.txt', 'setup.rst',
'example/remoteinterp.txt', 'example/remoteinterp.rst',
] ]

View File

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

View File

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

View File

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

View File

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