Skip to content

Commit 6e44c77

Browse files
Stephan SokolowStephan Sokolow
Stephan Sokolow
authored and
Stephan Sokolow
committed
Bring author attribution up to snuff
Add... - A unified "Authors" page at the end of the HTML manual - An AUTHORS file in the root of the project - A script to generate AUTHORS from the ReST sources - A section on AUTHORS in the developer's guide - An "et al" to the site footer that should have been there since the beginning (Thanks to PR #112 for reminding me to do this.)
1 parent 3a9d43f commit 6e44c77

File tree

7 files changed

+363
-44
lines changed

7 files changed

+363
-44
lines changed

‎AUTHORS‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
Authors
2+
*******
3+
4+
IMPORTANT: THIS DOCUMENT IS AUTOGENERATED. To update it, modify
5+
docs/authors/index.rst in the QuickTile source distribution and run
6+
docs/update_authors.sh
7+
8+
NOTE: Due to limitations in Sphinx's generation of text output,
9+
attribution URLs are missing from this version and the textual
10+
rendering of inline images is less than ideal. The HTML version
11+
included in the QuickTile manual should be preferred where possible.
12+
13+
14+
The Program
15+
===========
16+
17+
QuickTile is primarily the work of Stephan Sokolow, however, it has
18+
received various contributions over the years.
19+
20+
Thanks go out to the following people:
21+
22+
David Stygstra
23+
Generalized the "move-to-center" command into the "move-to-*"
24+
family of commands.
25+
26+
Justin
27+
Added the "horizontal-maximize", "vertical-maximize", and "move-to-
28+
center" commands.
29+
30+
Matthias Putz
31+
Fixed use of an uninitialized variable in a difficult-to-trigger
32+
failure case.
33+
34+
Max Weiß
35+
36+
* Added the "KEYLOOKUP" dict to compensate for un-intuitive
37+
omissions for the symbol names of common keys.
38+
39+
* Reworked the shebang to address the period when some Linux
40+
distros lacked a **python2** binary while others linked
41+
**python** to Python 3.
42+
43+
Oliver Gerlich
44+
Corrected an omission on the list of dependencies for CentOS 7 and
45+
possibly other Red Hat-family distros.
46+
47+
Stéphane Gourichon
48+
49+
* Researched how to create ".deb" packages
50+
51+
* Wrote "recompile_local_debian_package.sh"
52+
53+
* Set up the necessary package metadata for building a ".deb".
54+
55+
Stuart Axelbrooke
56+
Corrected a flaw in the window-tiling heuristics which prevented
57+
them from functioning correctly on especially large monitors.
58+
59+
Valdis Vitolins
60+
Added an omitted dependency on "python-setuptools" to "README.rst"
61+
62+
Valentin Agachi
63+
Corrected window-layout calculations to use "round()" for pixel
64+
values.
65+
66+
Yuting/Tim Xiao
67+
Made the window-tiling heuristics more robust.
68+
69+
70+
The Manual
71+
==========
72+
73+
With the following exceptions, all text and illustrations in the
74+
manual are copyright Stephan Sokolow.
75+
76+
It should be assumed that, as the contents of the API documentation
77+
section are extracted from the source code, the copyright of a given
78+
entry will be the same as the code it describes.
79+
80+
The text of the Alabaster theme for Sphinx, and any generated text
81+
inserted by Sphinx are copyright their respective rightsholders.
82+
83+
84+
Imagery
85+
-------
86+
87+
The following illustrations are copyright David Stygstra:
88+
89+
* "bordered.svg"
90+
91+
* "bottom-left.svg"
92+
93+
* "bottom-right.svg"
94+
95+
* "bottom.svg"
96+
97+
* "fullscreen.svg"
98+
99+
* "horizontal-maximize.svg"
100+
101+
* "left.svg"
102+
103+
* "maximize.svg"
104+
105+
* "middle.svg"
106+
107+
* "minimize.svg"
108+
109+
* "move-to-bottom-left.svg"
110+
111+
* "move-to-bottom-right.svg"
112+
113+
* "move-to-bottom.svg"
114+
115+
* "move-to-center.svg"
116+
117+
* "move-to-left.svg"
118+
119+
* "move-to-right.svg"
120+
121+
* "move-to-top-left.svg"
122+
123+
* "move-to-top-right.svg"
124+
125+
* "move-to-top.svg"
126+
127+
* "right.svg"
128+
129+
* "shade.svg"
130+
131+
* "top-left.svg"
132+
133+
* "top-right.svg"
134+
135+
* "top.svg"
136+
137+
* "vertical-maximize.svg"
138+
139+
[image: bug.png][image] and [image: wrench.png][image] from the Silk
140+
Icons set by Mark James are used under the Creative Commons
141+
Attribution 2.5 license.
142+
143+
The [image: GPLv2+ License][image] badge is a locally cached copy of
144+
an SVG file generated by Shields.io.
145+
146+
All other favicons and logos are copyright their respective owners and
147+
used only to display favicon-style links to their owners' websites.

‎docs/AUTHORS‎

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎docs/authors/index.rst‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
..
2+
IMPORTANT: Sphinx's text output silently erases hyperlinks without
3+
presenting the URLs in another fashion and renders inline images in a
4+
somewhat ugly style. Please bear this in mind when editing.
5+
6+
Authors
7+
=======
8+
9+
.. only:: text
10+
11+
IMPORTANT: THIS DOCUMENT IS AUTOGENERATED. To update it, modify
12+
docs/authors/index.rst in the QuickTile source distribution and run
13+
docs/update_authors.sh
14+
15+
NOTE: Due to limitations in Sphinx's generation of text output, attribution
16+
URLs are missing from this version and the textual rendering of inline
17+
images is less than ideal. The HTML version included in the QuickTile
18+
manual should be preferred where possible.
19+
20+
The Program
21+
-----------
22+
23+
QuickTile is primarily the work of `Stephan Sokolow`_, however, it has received
24+
various contributions over the years.
25+
26+
Thanks go out to the following people:
27+
28+
`David Stygstra`_
29+
Generalized the ``move-to-center`` command into the ``move-to-*`` family
30+
of commands.
31+
32+
Justin
33+
Added the ``horizontal-maximize``, ``vertical-maximize``, and
34+
``move-to-center`` commands.
35+
36+
Matthias Putz
37+
Fixed use of an uninitialized variable in a difficult-to-trigger failure
38+
case.
39+
40+
`Max Weiß`_
41+
42+
* Added the ``KEYLOOKUP`` dict to compensate for un-intuitive omissions for
43+
the symbol names of common keys.
44+
* Reworked the shebang to address the period when some Linux distros lacked
45+
a :command:`python2` binary while others linked :command:`python` to
46+
Python 3.
47+
48+
`Oliver Gerlich`_
49+
Corrected an omission on the list of dependencies for CentOS 7 and possibly
50+
other Red Hat-family distros.
51+
52+
`Stéphane Gourichon`_
53+
54+
* Researched how to create ``.deb`` packages
55+
* Wrote :file:`recompile_local_debian_package.sh`
56+
* Set up the necessary package metadata for building a ``.deb``.
57+
58+
`Stuart Axelbrooke`_
59+
Corrected a flaw in the window-tiling heuristics which prevented them
60+
from functioning correctly on especially large monitors.
61+
62+
`Valdis Vitolins`_
63+
Added an omitted dependency on ``python-setuptools`` to :file:`README.rst`
64+
65+
`Valentin Agachi`_
66+
Corrected window-layout calculations to use :py:func:`round` for pixel
67+
values.
68+
69+
`Yuting/Tim Xiao`_
70+
Made the window-tiling heuristics more robust.
71+
72+
The Manual
73+
----------
74+
75+
With the following exceptions, all text and illustrations in the manual are
76+
copyright `Stephan Sokolow`_.
77+
78+
It should be assumed that, as the contents of the API documentation section are
79+
extracted from the source code, the copyright of a given entry will be the same
80+
as the code it describes.
81+
82+
The text of the Alabaster_ theme for Sphinx_, and any generated text inserted
83+
by Sphinx are copyright their respective rightsholders.
84+
85+
Imagery
86+
^^^^^^^
87+
88+
The following illustrations are copyright `David Stygstra`_:
89+
90+
* ``bordered.svg``
91+
* ``bottom-left.svg``
92+
* ``bottom-right.svg``
93+
* ``bottom.svg``
94+
* ``fullscreen.svg``
95+
* ``horizontal-maximize.svg``
96+
* ``left.svg``
97+
* ``maximize.svg``
98+
* ``middle.svg``
99+
* ``minimize.svg``
100+
* ``move-to-bottom-left.svg``
101+
* ``move-to-bottom-right.svg``
102+
* ``move-to-bottom.svg``
103+
* ``move-to-center.svg``
104+
* ``move-to-left.svg``
105+
* ``move-to-right.svg``
106+
* ``move-to-top-left.svg``
107+
* ``move-to-top-right.svg``
108+
* ``move-to-top.svg``
109+
* ``right.svg``
110+
* ``shade.svg``
111+
* ``top-left.svg``
112+
* ``top-right.svg``
113+
* ``top.svg``
114+
* ``vertical-maximize.svg``
115+
116+
|bug.png| and |wrench.png| from the `Silk Icons`_ set by `Mark James`_
117+
are used under the `Creative Commons Attribution 2.5`_ license.
118+
119+
120+
The |license.svg| badge is a locally cached copy of an SVG file generated by
121+
Shields.io_.
122+
123+
All other favicons and logos are copyright their respective owners and used
124+
only to display favicon-style links to their owners' websites.
125+
126+
.. |bug.png| image:: ../_static/contrib_box/bug.png
127+
.. |wrench.png| image:: ../wrench.png
128+
129+
.. |license.svg| image:: ../_static/license.svg
130+
:alt: GPLv2+ License
131+
132+
.. _Alabaster: https://alabaster.readthedocs.io/
133+
.. _Creative Commons Attribution 2.5: https://creativecommons.org/licenses/by/2.5/
134+
.. _David Stygstra: https://github.com/stygstra
135+
.. _Mark James: https://twitter.com/markjames
136+
.. _Max Weiß: https://github.com/wmax
137+
.. _Oliver Gerlich: https://github.com/oliver
138+
.. _Shields.io: https://shields.io/
139+
.. _Silk Icons: http://www.famfamfam.com/lab/icons/silk/
140+
.. _Sphinx: https://alabaster.readthedocs.io/
141+
.. _Stephan Sokolow: http://ssokolow.com/
142+
.. _Stéphane Gourichon: https://github.com/fidergo-stephane-gourichon
143+
.. _Stuart Axelbrooke: https://github.com/soaxelbrooke
144+
.. _Valdis Vitolins: https://github.com/valdisvi
145+
.. _Valentin Agachi: https://github.com/avaly
146+
.. _Yuting/Tim Xiao: https://github.com/txiao
147+
148+
..
149+
NOTE: For "Yuting/Tim Xiao", the commits are signed "Yuting Xiao" but the
150+
name on the associated GitHub account has since been changed to "Tim Xiao".
151+
I am operating on the assumption that this is a case of "Yuting" being the
152+
contributor's legal name and "Tim" being a nickname the contributor has
153+
taken to more easily interact with peers... it's apparently a common
154+
practice.

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ def setup(app):
8989
# General information about the project.
9090
project = u'QuickTile'
9191
author = u'Stephan Sokolow'
92-
copyright = u'2009-2020, Stephan Sokolow' # pylint: disable=W0622
92+
copyright = u'2009-2020, Stephan Sokolow et al' # pylint: disable=W0622
9393

9494
# The version info for the project you're documenting, acts as replacement for
9595
# |version| and |release|, also used in various other places throughout the

0 commit comments

Comments
 (0)