Improved text on plugins_index

- Removed "beta" status from it;
- Added links to pytest-plugs app;

--HG--
branch : integrate-plugin-index-docs
This commit is contained in:
Bruno Oliveira
2014-02-18 21:33:13 -03:00
parent 2893cddb68
commit 0559f11aa5
4 changed files with 157 additions and 120 deletions
+27 -6
View File
@@ -1,6 +1,13 @@
"""
Script to generate the file `index.txt` with information about
pytest plugins taken directly from a live PyPI server.
pytest plugins taken directly from PyPI.
Usage:
python plugins_index.py
This command will update `index.txt` in the same directory found as this script.
This should be issued before every major documentation release to obtain latest
versions from PyPI.
Also includes plugin compatibility between different python and pytest versions,
obtained from http://pytest-plugs.herokuapp.com.
@@ -167,11 +174,9 @@ def generate_plugins_index_from_table(filename, headers, rows):
return ' '.join(char * length for length in column_lengths)
with open(filename, 'w') as f:
# write welcome
print('.. _plugins_index:', file=f)
print(file=f)
print('List of Third-Party Plugins', file=f)
print('===========================', file=f)
# header
header_text = HEADER.format(pytest_version=pytest.__version__)
print(header_text, file=f)
print(file=f)
# table
@@ -232,5 +237,21 @@ def main(argv):
return 0
# header for the plugins_index page
HEADER = '''.. _plugins_index:
List of Third-Party Plugins
===========================
The table below contains a listing of plugins found in PyPI and
their status when tested using py.test **{pytest_version}** and python 2.7 and
3.3.
A complete listing can also be found at
`pytest-plugs <http://pytest-plugs.herokuapp.com/>`_, which contains tests
status against other py.test releases.
'''
if __name__ == '__main__':
sys.exit(main(sys.argv))