p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix some doc bits 

--HG--
branch : trunk
This commit is contained in:
holger krekel 2010-10-22 10:09:26 +02:00
parent 47e56e0dee
commit 76a1bf391e
6 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/conf.py
View File

@ -64,7 +64,7 @@ release = '2.0.0dev0'
# 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 = ['_build', 'test', 'announce'] # XXX exclude_patterns = ['links.inc', '_build', 'test', 'announce'] # XXX
# The reST default role (used for this markup: `text`) to use for all documents. # The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None #default_role = None

10
doc/customize.txt
View File

@ -79,10 +79,10 @@ in your home directory to provide global configuration values.
.. Note:: .. Note::
if you have ``conftest.py`` files which do not reside in a if you have ``conftest.py`` files which do not reside in a
python package directory (one containing an ``__init__.py``) then python package directory (i.e. one containing an ``__init__.py``) then
"import conftest" will be ambigous and should be avoided. **If you "import conftest" will be ambigous and should be avoided. If you
want to import anything from a ``conftest.py`` file it is better ever want to import anything from a ``conftest.py`` file
to put it inside a package to disambiguate. put it inside a package. You avoid trouble this way.
.. _`named plugins`: plugin/index.html .. _`named plugins`: plugin/index.html
@ -128,7 +128,7 @@ Writing per-project plugins (conftest.py)
The purpose of :file:`conftest.py` files is to allow project-specific The purpose of :file:`conftest.py` files is to allow project-specific
test customization. They thus make for a good place to implement test customization. They thus make for a good place to implement
project-specific test related features through hooks. For example you may project-specific test related features through hooks. For example you may
set the `collect_ignore`_ variable depending on a command line option set the ``collect_ignore`` variable depending on a command line option
by defining the following hook in a ``conftest.py`` file:: by defining the following hook in a ``conftest.py`` file::
# ./conftest.py in your root or package dir # ./conftest.py in your root or package dir

3
doc/faq.txt
View File

@ -9,6 +9,9 @@ Installation issues
easy_install or py.test not found on Windows machine easy_install or py.test not found on Windows machine
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. _`Python for Windows`: http://www.imladris.com/Scripts/PythonForWindows.html
- **Windows**: If "easy_install" or "py.test" are not found - **Windows**: If "easy_install" or "py.test" are not found
please see here for preparing your environment for running please see here for preparing your environment for running
command line tools: `Python for Windows`_. You may alternatively command line tools: `Python for Windows`_. You may alternatively

1
doc/getting-started.txt
View File

@ -78,3 +78,4 @@ Here are a few suggestions where to go next:
* :ref:`apiref` for documentation and examples on writing Python tests * :ref:`apiref` for documentation and examples on writing Python tests
* :ref:`examples` for more complex examples * :ref:`examples` for more complex examples
.. include:: links.inc

2
doc/goodpractises.txt
View File

@ -48,8 +48,6 @@ disguise. You can tell people to download and then e.g. run it like this::
and ask them to send you the resulting URL. The resulting script has and ask them to send you the resulting URL. The resulting script has
all core features and runs unchanged under Python2 and Python3 interpreters. all core features and runs unchanged under Python2 and Python3 interpreters.
.. _`Python for Windows`: http://www.imladris.com/Scripts/PythonForWindows.html
.. _`Distribute for installation`: http://pypi.python.org/pypi/distribute#installation-instructions .. _`Distribute for installation`: http://pypi.python.org/pypi/distribute#installation-instructions
.. _`distribute installation`: http://pypi.python.org/pypi/distribute .. _`distribute installation`: http://pypi.python.org/pypi/distribute

2
doc/links.inc
View File

@ -10,6 +10,8 @@
.. _pytest: http://pypi.python.org/pypi/pytest .. _pytest: http://pypi.python.org/pypi/pytest
.. _mercurial: http://mercurial.selenic.com/wiki/ .. _mercurial: http://mercurial.selenic.com/wiki/
.. _`setuptools`: http://pypi.python.org/pypi/setuptools .. _`setuptools`: http://pypi.python.org/pypi/setuptools
.. _`easy_install`:
.. _`distribute`: http://pypi.python.org/pypi/distribute .. _`distribute`: http://pypi.python.org/pypi/distribute
.. _`pip`: http://pypi.python.org/pypi/pip .. _`pip`: http://pypi.python.org/pypi/pip
.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv .. _`virtualenv`: http://pypi.python.org/pypi/virtualenv