Skip to content

Commit

Permalink
Bring author attribution up to snuff
Browse files Browse the repository at this point in the history
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.)
  • Loading branch information
Stephan Sokolow authored and Stephan Sokolow committed Feb 10, 2020
1 parent 3a9d43f commit 6e44c77
Show file tree
Hide file tree
Showing 7 changed files with 363 additions and 44 deletions.
147 changes: 147 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
Authors
*******

IMPORTANT: THIS DOCUMENT IS AUTOGENERATED. To update it, modify
docs/authors/index.rst in the QuickTile source distribution and run
docs/update_authors.sh

NOTE: Due to limitations in Sphinx's generation of text output,
attribution URLs are missing from this version and the textual
rendering of inline images is less than ideal. The HTML version
included in the QuickTile manual should be preferred where possible.


The Program
===========

QuickTile is primarily the work of Stephan Sokolow, however, it has
received various contributions over the years.

Thanks go out to the following people:

David Stygstra
Generalized the "move-to-center" command into the "move-to-*"
family of commands.

Justin
Added the "horizontal-maximize", "vertical-maximize", and "move-to-
center" commands.

Matthias Putz
Fixed use of an uninitialized variable in a difficult-to-trigger
failure case.

Max Weiß

* Added the "KEYLOOKUP" dict to compensate for un-intuitive
omissions for the symbol names of common keys.

* Reworked the shebang to address the period when some Linux
distros lacked a **python2** binary while others linked
**python** to Python 3.

Oliver Gerlich
Corrected an omission on the list of dependencies for CentOS 7 and
possibly other Red Hat-family distros.

Stéphane Gourichon

* Researched how to create ".deb" packages

* Wrote "recompile_local_debian_package.sh"

* Set up the necessary package metadata for building a ".deb".

Stuart Axelbrooke
Corrected a flaw in the window-tiling heuristics which prevented
them from functioning correctly on especially large monitors.

Valdis Vitolins
Added an omitted dependency on "python-setuptools" to "README.rst"

Valentin Agachi
Corrected window-layout calculations to use "round()" for pixel
values.

Yuting/Tim Xiao
Made the window-tiling heuristics more robust.


The Manual
==========

With the following exceptions, all text and illustrations in the
manual are copyright Stephan Sokolow.

It should be assumed that, as the contents of the API documentation
section are extracted from the source code, the copyright of a given
entry will be the same as the code it describes.

The text of the Alabaster theme for Sphinx, and any generated text
inserted by Sphinx are copyright their respective rightsholders.


Imagery
-------

The following illustrations are copyright David Stygstra:

* "bordered.svg"

* "bottom-left.svg"

* "bottom-right.svg"

* "bottom.svg"

* "fullscreen.svg"

* "horizontal-maximize.svg"

* "left.svg"

* "maximize.svg"

* "middle.svg"

* "minimize.svg"

* "move-to-bottom-left.svg"

* "move-to-bottom-right.svg"

* "move-to-bottom.svg"

* "move-to-center.svg"

* "move-to-left.svg"

* "move-to-right.svg"

* "move-to-top-left.svg"

* "move-to-top-right.svg"

* "move-to-top.svg"

* "right.svg"

* "shade.svg"

* "top-left.svg"

* "top-right.svg"

* "top.svg"

* "vertical-maximize.svg"

[image: bug.png][image] and [image: wrench.png][image] from the Silk
Icons set by Mark James are used under the Creative Commons
Attribution 2.5 license.

The [image: GPLv2+ License][image] badge is a locally cached copy of
an SVG file generated by Shields.io.

All other favicons and logos are copyright their respective owners and
used only to display favicon-style links to their owners' websites.
43 changes: 0 additions & 43 deletions docs/AUTHORS

This file was deleted.

154 changes: 154 additions & 0 deletions docs/authors/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
..
IMPORTANT: Sphinx's text output silently erases hyperlinks without
presenting the URLs in another fashion and renders inline images in a
somewhat ugly style. Please bear this in mind when editing.
Authors
=======

.. only:: text

IMPORTANT: THIS DOCUMENT IS AUTOGENERATED. To update it, modify
docs/authors/index.rst in the QuickTile source distribution and run
docs/update_authors.sh

NOTE: Due to limitations in Sphinx's generation of text output, attribution
URLs are missing from this version and the textual rendering of inline
images is less than ideal. The HTML version included in the QuickTile
manual should be preferred where possible.

The Program
-----------

QuickTile is primarily the work of `Stephan Sokolow`_, however, it has received
various contributions over the years.

Thanks go out to the following people:

`David Stygstra`_
Generalized the ``move-to-center`` command into the ``move-to-*`` family
of commands.

Justin
Added the ``horizontal-maximize``, ``vertical-maximize``, and
``move-to-center`` commands.

Matthias Putz
Fixed use of an uninitialized variable in a difficult-to-trigger failure
case.

`Max Weiß`_

* Added the ``KEYLOOKUP`` dict to compensate for un-intuitive omissions for
the symbol names of common keys.
* Reworked the shebang to address the period when some Linux distros lacked
a :command:`python2` binary while others linked :command:`python` to
Python 3.

`Oliver Gerlich`_
Corrected an omission on the list of dependencies for CentOS 7 and possibly
other Red Hat-family distros.

`Stéphane Gourichon`_

* Researched how to create ``.deb`` packages
* Wrote :file:`recompile_local_debian_package.sh`
* Set up the necessary package metadata for building a ``.deb``.

`Stuart Axelbrooke`_
Corrected a flaw in the window-tiling heuristics which prevented them
from functioning correctly on especially large monitors.

`Valdis Vitolins`_
Added an omitted dependency on ``python-setuptools`` to :file:`README.rst`

`Valentin Agachi`_
Corrected window-layout calculations to use :py:func:`round` for pixel
values.

`Yuting/Tim Xiao`_
Made the window-tiling heuristics more robust.

The Manual
----------

With the following exceptions, all text and illustrations in the manual are
copyright `Stephan Sokolow`_.

It should be assumed that, as the contents of the API documentation section are
extracted from the source code, the copyright of a given entry will be the same
as the code it describes.

The text of the Alabaster_ theme for Sphinx_, and any generated text inserted
by Sphinx are copyright their respective rightsholders.

Imagery
^^^^^^^

The following illustrations are copyright `David Stygstra`_:

* ``bordered.svg``
* ``bottom-left.svg``
* ``bottom-right.svg``
* ``bottom.svg``
* ``fullscreen.svg``
* ``horizontal-maximize.svg``
* ``left.svg``
* ``maximize.svg``
* ``middle.svg``
* ``minimize.svg``
* ``move-to-bottom-left.svg``
* ``move-to-bottom-right.svg``
* ``move-to-bottom.svg``
* ``move-to-center.svg``
* ``move-to-left.svg``
* ``move-to-right.svg``
* ``move-to-top-left.svg``
* ``move-to-top-right.svg``
* ``move-to-top.svg``
* ``right.svg``
* ``shade.svg``
* ``top-left.svg``
* ``top-right.svg``
* ``top.svg``
* ``vertical-maximize.svg``

|bug.png| and |wrench.png| from the `Silk Icons`_ set by `Mark James`_
are used under the `Creative Commons Attribution 2.5`_ license.


The |license.svg| badge is a locally cached copy of an SVG file generated by
Shields.io_.

All other favicons and logos are copyright their respective owners and used
only to display favicon-style links to their owners' websites.

.. |bug.png| image:: ../_static/contrib_box/bug.png
.. |wrench.png| image:: ../wrench.png

.. |license.svg| image:: ../_static/license.svg
:alt: GPLv2+ License

.. _Alabaster: https://alabaster.readthedocs.io/
.. _Creative Commons Attribution 2.5: https://creativecommons.org/licenses/by/2.5/
.. _David Stygstra: https://github.com/stygstra
.. _Mark James: https://twitter.com/markjames
.. _Max Weiß: https://github.com/wmax
.. _Oliver Gerlich: https://github.com/oliver
.. _Shields.io: https://shields.io/
.. _Silk Icons: http://www.famfamfam.com/lab/icons/silk/
.. _Sphinx: https://alabaster.readthedocs.io/
.. _Stephan Sokolow: http://ssokolow.com/
.. _Stéphane Gourichon: https://github.com/fidergo-stephane-gourichon
.. _Stuart Axelbrooke: https://github.com/soaxelbrooke
.. _Valdis Vitolins: https://github.com/valdisvi
.. _Valentin Agachi: https://github.com/avaly
.. _Yuting/Tim Xiao: https://github.com/txiao

..
NOTE: For "Yuting/Tim Xiao", the commits are signed "Yuting Xiao" but the
name on the associated GitHub account has since been changed to "Tim Xiao".
I am operating on the assumption that this is a case of "Yuting" being the
contributor's legal name and "Tim" being a nickname the contributor has
taken to more easily interact with peers... it's apparently a common
practice.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ def setup(app):
# General information about the project.
project = u'QuickTile'
author = u'Stephan Sokolow'
copyright = u'2009-2020, Stephan Sokolow' # pylint: disable=W0622
copyright = u'2009-2020, Stephan Sokolow et al' # pylint: disable=W0622

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

0 comments on commit 6e44c77

Please sign in to comment.