diff --git a/py/doc/conftest.py b/py/doc/conftest.py index d26d9ad56..61eadae2e 100644 --- a/py/doc/conftest.py +++ b/py/doc/conftest.py @@ -6,8 +6,8 @@ Option = py.test.config.Option option = py.test.config.addoptions("documentation check options", Option('-R', '--checkremote', action="store_true", dest="checkremote", default=False, - help="check remote links in ReST files" - ), + help="perform tests involving remote accesses (links, svn)" + ), Option('', '--forcegen', action="store_true", dest="forcegen", default=False, help="force generation of html files even if they appear up-to-date" diff --git a/py/doc/path.txt b/py/doc/path.txt index da5d0d2b9..f4564cfae 100644 --- a/py/doc/path.txt +++ b/py/doc/path.txt @@ -51,6 +51,8 @@ solutions. Some example usage of :api:`py.path.svnurl`:: + .. >>> import py + .. >>> if not getattr(py.test.config.option, 'checkremote', 0): py.test.skip("use --checkremote to enable svn remote doctests") >>> url = py.path.svnurl('http://codespeak.net/svn/py') >>> info = url.info() >>> info.kind