From 76a1bf391eacd236a67b14f291191b7ff57fb802 Mon Sep 17 00:00:00 2001 From: holger krekel Date: Fri, 22 Oct 2010 10:09:26 +0200 Subject: [PATCH] fix some doc bits --HG-- branch : trunk --- doc/conf.py | 2 +- doc/customize.txt | 10 +++++----- doc/faq.txt | 3 +++ doc/getting-started.txt | 1 + doc/goodpractises.txt | 2 -- doc/links.inc | 2 ++ 6 files changed, 12 insertions(+), 8 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 9bbb43fb8..f1bc56f46 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -64,7 +64,7 @@ release = '2.0.0dev0' # List of patterns, relative to source directory, that match files and # 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. #default_role = None diff --git a/doc/customize.txt b/doc/customize.txt index a32bec338..91404806f 100644 --- a/doc/customize.txt +++ b/doc/customize.txt @@ -79,10 +79,10 @@ in your home directory to provide global configuration values. .. Note:: if you have ``conftest.py`` files which do not reside in a - python package directory (one containing an ``__init__.py``) then - "import conftest" will be ambigous and should be avoided. **If you - want to import anything from a ``conftest.py`` file it is better - to put it inside a package to disambiguate. + python package directory (i.e. one containing an ``__init__.py``) then + "import conftest" will be ambigous and should be avoided. If you + ever want to import anything from a ``conftest.py`` file + put it inside a package. You avoid trouble this way. .. _`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 test customization. They thus make for a good place to implement 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:: # ./conftest.py in your root or package dir diff --git a/doc/faq.txt b/doc/faq.txt index 58f8f7b4d..f0ede1d73 100644 --- a/doc/faq.txt +++ b/doc/faq.txt @@ -9,6 +9,9 @@ Installation issues 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 please see here for preparing your environment for running command line tools: `Python for Windows`_. You may alternatively diff --git a/doc/getting-started.txt b/doc/getting-started.txt index 1094c44ff..26a360d87 100644 --- a/doc/getting-started.txt +++ b/doc/getting-started.txt @@ -78,3 +78,4 @@ Here are a few suggestions where to go next: * :ref:`apiref` for documentation and examples on writing Python tests * :ref:`examples` for more complex examples +.. include:: links.inc diff --git a/doc/goodpractises.txt b/doc/goodpractises.txt index a95d41dd9..47b6b43c5 100644 --- a/doc/goodpractises.txt +++ b/doc/goodpractises.txt @@ -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 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 installation`: http://pypi.python.org/pypi/distribute diff --git a/doc/links.inc b/doc/links.inc index 9bcfe5cf8..5cd550230 100644 --- a/doc/links.inc +++ b/doc/links.inc @@ -10,6 +10,8 @@ .. _pytest: http://pypi.python.org/pypi/pytest .. _mercurial: http://mercurial.selenic.com/wiki/ .. _`setuptools`: http://pypi.python.org/pypi/setuptools + +.. _`easy_install`: .. _`distribute`: http://pypi.python.org/pypi/distribute .. _`pip`: http://pypi.python.org/pypi/pip .. _`virtualenv`: http://pypi.python.org/pypi/virtualenv