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

View File

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

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']
# 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',
]

View File

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

View File

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

View File

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

View File

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