✨ print authors under each guide, add a "hall of fame"

Author: luto

.gitignore

@@ -2,19 +2,116 @@
 .DS_Store
 .Thumbs.db
 
-# virtualenv
-venv
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-
 # ansible
 *.retry
 
 # Sphinx
 build
+*.doctree
+*.doctrees
 
 # CI
 .sshkey
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache/
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule.*
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+
+# End of https://www.gitignore.io/api/python

authorship/authorship/__init__.py

@@ -0,0 +1,76 @@
+import itertools
+
+from docutils import nodes
+from sphinx.util.docutils import SphinxDirective
+from docutils.parsers.rst import directives
+
+
+def generate_author_list(authors):
+    return [
+        nodes.Text(a, a)
+        for a in authors
+    ]
+
+
+class Author(SphinxDirective):
+    required_arguments = 1
+    final_argument_whitespace = True
+
+    def run(self):
+        env = self.state.document.settings.env
+
+        env.authors.setdefault(env.docname, [])
+        env.authors[env.docname].append(self.arguments[0])
+
+        return []
+
+
+class Authors(SphinxDirective):
+    def run(self):
+        env = self.state.document.settings.env
+        return generate_author_list(env.authors.get(env.docname, []))
+
+
+# maker node later to be replaced by list of all authors
+class allauthors(nodes.General, nodes.Element):
+    pass
+
+
+class AllAuthors(SphinxDirective):
+    def run(self):
+        return [allauthors('')]
+
+
+def builder_inited(app):
+    app.builder.env.authors = {}
+
+
+def purge_authors(app, env, docname):
+    if not hasattr(env, 'authors'):
+        return
+
+    env.authors.pop(docname, None)
+
+
+def process_authorlists(app, doctree, fromdocname):
+    env = app.builder.env
+    authors = set(itertools.chain(*[authors for authors in env.authors.values()]))
+
+    for node in doctree.traverse(allauthors):
+        node.replace_self(generate_author_list(authors))
+
+
+def setup(app):
+    app.add_node(allauthors)
+
+    directives.register_directive('author', Author)
+    directives.register_directive('authors', Authors)
+    directives.register_directive('allauthors', AllAuthors)
+
+    app.connect('builder-inited', builder_inited)
+    app.connect('env-purge-doc', purge_authors)
+    app.connect('doctree-resolved', process_authorlists)
+
+    return {
+        'version': '1.0.0',
+    }

authorship/setup.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python
+
+from setuptools import setup, find_packages
+
+setup(
+    name = 'authorship',
+    version = '1.0.0',
+    author = 'uberspace.de',
+    author_email = '[email protected]',
+    packages = find_packages(),
+    install_requires = [
+    ],
+)

requirements.txt

@@ -1,4 +1,6 @@
-Sphinx==1.7.*
+# replace with 1.7.3 once released
+git+git://github.com/sphinx-doc/sphinx@b5ddc8c6977ac964e3ba4a2eb4647decdc742f4f
 sphinx-rtd-theme==0.2.*
 sphinx-autobuild==0.7.*
 feedgen==0.6.1
+./authorship

source/conf.py

@@ -32,7 +32,9 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = [
+  'authorship',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

source/contributors.rst

@@ -0,0 +1,5 @@
+############
+Contributors
+############
+
+.. allauthors::

source/guide_etherpad.rst

@@ -1,4 +1,4 @@
-.. sectionauthor:: ezzra <[email protected]>
+.. author:: ezzra <[email protected]>
 .. highlight:: console
 
 #############
@@ -225,3 +225,5 @@ Then you need to restart the service daemon, so the new code is used by the webs
 ----
 
 Tested with Etherpad Lite 1.6.3 and Uberspace 7.1.1 
+
+.. authors::

source/guide_ghost.rst

@@ -1,4 +1,4 @@
-.. sectionauthor:: Uberspace <[email protected]>
+.. author:: Uberspace <[email protected]>
 .. highlight:: console
 
 .. sidebar:: Logo
@@ -238,3 +238,5 @@ If it's not in state RUNNING, check your configuration.
 ----
 
 Tested with Ghost 1.22.1, Uberspace 7.1.1
+
+.. authors::

source/guide_gitea.rst

@@ -1,4 +1,4 @@
-.. sectionauthor:: Uberspace <[email protected]>
+.. author:: Uberspace <[email protected]>
 .. highlight:: console
 
 .. sidebar:: Logo
@@ -174,3 +174,5 @@ version is available, repeat the "Installation" step followed by ``supervisorctl
 ----
 
 Tested with Gitea 1.4.0, Uberspace 7.1.3
+
+.. authors::

source/guide_jingo.rst

@@ -1,4 +1,4 @@
-.. sectionauthor:: ezzra <[email protected]>
+.. author:: ezzra <[email protected]>
 .. highlight:: console
 
 #####
@@ -256,3 +256,5 @@ In the end you need to restart the service daemon, so the new code is used by th
 ----
 
 Tested with Jingo 1.8.5, Uberspace 7.1.1
+
+.. authors::

source/guide_lychee.rst

@@ -1,4 +1,4 @@
-.. sectionauthor:: TheForcer <[email protected]>
+.. author:: TheForcer <[email protected]>
 .. highlight:: console
 
 .. sidebar:: Logo
@@ -90,3 +90,5 @@ If a new version is available, ``cd`` to your Lychee folder and do a simple ``gi
 ----
 
 Tested with Lychee 3.1.6, Uberspace 7.1.1
+
+.. authors::

source/guide_minim.rst

@@ -1,4 +1,4 @@
-.. sectionauthor:: minim <[email protected]>
+.. author:: minim <[email protected]>
 .. highlight:: console
 
 .. sidebar:: Logo
@@ -113,3 +113,5 @@ If everything works alright you can delete your ``minim-backup`` and the ``confi
 ----
 
 Tested with minim - Blog 0.5.0.1 and minim - Wiki 0.1.0.1, Uberspace 7.1.1
+
+.. authors::

source/guide_wallabag.rst

@@ -156,3 +156,5 @@ If there is a new version available, you can get the code using git:
 ----
 
 Tested with Wallabag 2.3.2 and Uberspace 7.1.2
+
+.. authors::

source/guide_wordpress.rst

@@ -1,4 +1,4 @@
-.. sectionauthor:: Uberspace <[email protected]>
+.. author:: Uberspace <[email protected]>
 .. highlight:: console
 
 .. sidebar:: Logo
@@ -93,3 +93,5 @@ By default, WordPress `automatically updates`_ itself to the latest stable minor
 ----
 
 Tested with WordPress 4.9.5, Uberspace 7.1.2
+
+.. authors::

source/index.rst

@@ -26,4 +26,5 @@ Thank you and have fun experimenting!
    :maxdepth: 1
    :glob:
 
+   contributors
    guide_*