Wolfgang Schnerring avatar Wolfgang Schnerring committed 35e1811

Move development info to HACKING and include it in PyPI and Sphinx

Comments (0)

Files changed (5)

+Developing gocept.selenium
+==========================
+
+:Author:
+    `gocept <http://gocept.com/>`_ <mail@gocept.com>
+
+:Online documentation:
+    http://packages.python.org/gocept.selenium/
+
+:PyPI page:
+    http://pypi.python.org/pypi/gocept.selenium/
+
+:Issue tracker:
+    https://projects.gocept.com/projects/gocept-selenium/
+
+:Source code:
+    https://bitbucket.org/gocept/gocept.selenium/
+
+:Current change log:
+    https://bitbucket.org/gocept/gocept.selenium/raw/tip/CHANGES.txt
+
+
+buildout configuration
+----------------------
+
+gocept.selenium integrates with quite a lot of different testing approaches and
+needs to work across a wide spectrum of software versions, e. g. Zope2 before
+and after eggification (2.10/2.12), ZTK-KGS, Grok-KGS, Plone3, Plone4 etc.
+
+This has two consequences, one is that we use different extras_require for the
+different flavours, so clients will need to specify that, e. g.
+gocept.selenium[ztk] or gocept.selenium[grok].
+
+The second is that there is no single buildout configuration for this package,
+but rather quite a lot of them, so we are able to run our tests against all the
+different software versions we integrate with.
+
+The base package itself is tested with ``selenium.cfg``, this has no further
+dependencies except the ``selenium`` package. The various flavours have their
+own cfg file, in some cases in several versions (e.g. Plone3/Plone4, Zope2
+pre/post eggs etc.). This means that in order to set up the buildout, you'll
+need to specify the configuration you want to test, like this::
+
+    $ python bootstrap.py -c ztk.cfg
+    $ bin/buildout -c ztk.cfg
+
+Note that the zope210 and plone3 configurations require Python-2.4, while the
+others should work at least up to Python-2.6.

README.txt

-======================
-buildout configuration
-======================
-
-gocept.selenium integrates with quite a lot of different testing approaches and
-needs to work across a wide spectrum of software versions, e. g. Zope2 before
-and after eggification (2.10/2.12), ZTK-KGS, Grok-KGS, Plone3, Plone4 etc.
-
-This has two consequences, one is that we use different extras_require for the
-different flavours, so clients will need to specify that, e. g.
-gocept.selenium[ztk] or gocept.selenium[grok].
-
-The second is that there is no single buildout configuration for this package,
-but rather quite a lot of them, so we are able to run our tests against all the
-different software versions we integrate with.
-
-The base package itself is tested with ``selenium.cfg``, this has no further
-dependencies except the ``selenium`` package. The various flavours have their
-own cfg file, in some cases in several versions (e.g. Plone3/Plone4, Zope2
-pre/post eggs etc.). This means that in order to set up the buildout, you'll
-need to specify the configuration you want to test, like this::
-
-    $ python bootstrap.py -c ztk.cfg
-    $ bin/buildout -c ztk.cfg
-
-Note that the zope210 and plone3 configurations require Python-2.4, while the
-others should work at least up to Python-2.6.

doc/development.rst

+.. include:: ../HACKING.txt
    api
    integration
    tips
+   development
    changes
     long_description=(
         open(os.path.join('src', 'gocept', 'selenium', 'README.txt')).read() +
         '\n\n' +
+        open('HACKING.txt').read() +
+        '\n\n' +
         open('CHANGES.txt').read()),
     packages=find_packages('src'),
     package_dir={'': 'src'},
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.