Merge pull request #1026 from moreati/netlify

docs: Fix generating static website on Netlify

docs/_templates/github.html

@@ -1,4 +1,4 @@
 <p>
 <br>
-<a class="github-button" href="https://github.com/dw/mitogen/" data-size="large" data-show-count="true" aria-label="Star dw/mitogen on GitHub">Star</a>
+<a class="github-button" href="https://github.com/mitogen-hq/mitogen/" data-size="large" data-show-count="true" aria-label="Star mitogen on GitHub">Star</a>
 </p>

docs/ansible_detailed.rst

@@ -18,7 +18,7 @@ The extension is considered stable and real-world use is encouraged.
 
 .. _Ansible: https://www.ansible.com/
 
-.. _Bug reports: https://goo.gl/yLKZiJ
+.. _Bug reports: https://github.com/mitogen-hq/mitogen/issues/new/choose
 
 
 Overview
@@ -147,8 +147,10 @@ Noteworthy Differences
 
 * Mitogen 0.2.x supports Ansible 2.3-2.9; with Python 2.6, 2.7, or 3.6.
   Mitogen 0.3.1+ supports
+
     - Ansible 2.10, 3, and 4; with Python 2.7, or 3.6-3.11
     - Ansible 5 and 6; with Python 3.8-3.11
+
   Verify your installation is running one of these versions by checking
   ``ansible --version`` output.
 
@@ -1291,7 +1293,7 @@ Sample Profiles
 ---------------
 
 The summaries below may be reproduced using data and scripts maintained in the
-`pcaps branch <https://github.com/dw/mitogen/tree/pcaps/>`_. Traces were
+`pcaps branch <https://github.com/mitogen-hq/mitogen/tree/pcaps/>`_. Traces were
 recorded using Ansible 2.5.14.
 
 
@@ -1300,7 +1302,7 @@ Trivial Loop: Local Host
 
 This demonstrates Mitogen vs. SSH pipelining to the local machine running
 `bench/loop-100-items.yml
-<https://github.com/dw/mitogen/blob/master/tests/ansible/bench/loop-100-items.yml>`_,
+<https://github.com/mitogen-hq/mitogen/blob/master/tests/ansible/bench/loop-100-items.yml>`_,
 executing a simple command 100 times. Most Ansible controller overhead is
 isolated, characterizing just module executor and connection layer performance.
 Mitogen requires **63x less bandwidth and 5.9x less time**.
@@ -1328,7 +1330,7 @@ File Transfer: UK to France
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 `This playbook
-<https://github.com/dw/mitogen/blob/master/tests/ansible/regression/issue_140__thread_pileup.yml>`_
+<https://github.com/mitogen-hq/mitogen/blob/master/tests/ansible/regression/issue_140__thread_pileup.yml>`_
 was used to compare file transfer performance over a ~26 ms link. It uses the
 ``with_filetree`` loop syntax to copy a directory of 1,000 0-byte files to the
 target.

docs/changelog.rst

@@ -15,7 +15,7 @@ Release Notes
     </style>
 
 To avail of fixes in an unreleased version, please download a ZIP file
-`directly from GitHub <https://github.com/dw/mitogen/>`_.
+`directly from GitHub <https://github.com/mitogen-hq/mitogen/>`_.
 
 Unreleased
 ----------
@@ -71,7 +71,7 @@ v0.3.0 (2021-11-24)
 -------------------
 
 This release separates itself from the v0.2.X releases. Ansible's API changed too much to support backwards compatibility so from now on, v0.2.X releases will be for Ansible < 2.10 and v0.3.X will be for Ansible 2.10+.
-`See here for details <https://github.com/dw/mitogen/pull/715#issuecomment-750697248>`_.
+`See here for details <https://github.com/mitogen-hq/mitogen/pull/715#issuecomment-750697248>`_.
 
 * :gh:issue:`827` NewStylePlanner: detect `ansible_collections` imports
 * :gh:issue:`770` better check for supported Ansible version
@@ -92,7 +92,7 @@ v0.2.10 (2021-11-24)
 * :gh:issue:`756` ssh connections with `check_host_keys='accept'` would
   timeout, when using recent OpenSSH client versions.
 * :gh:issue:`758` fix initilialisation of callback plugins in test suite, to address a `KeyError` in
-  :method:`ansible.plugins.callback.CallbackBase.v2_runner_on_start`
+  :py:meth:`ansible.plugins.callback.CallbackBase.v2_runner_on_start`
 * :gh:issue:`775` Test with Python 3.9
 * :gh:issue:`775` Add msvcrt to the default module deny list
 
@@ -178,7 +178,7 @@ Mitogen for Ansible
   :linux:man7:`unix` sockets across privilege domains.
 
 * :gh:issue:`467`: an incompatibility running Mitogen under `Molecule
-  <https://molecule.readthedocs.io/en/stable/>`_ was resolved.
+  <https://ansible.readthedocs.io/projects/molecule/>`_ was resolved.
 
 * :gh:issue:`547`, :gh:issue:`598`: fix a deadlock during initialization of
   connections, ``async`` tasks, tasks using custom :mod:`module_utils`,
@@ -1230,9 +1230,8 @@ Core Library
   parameter may specify an argument vector prefix rather than a string program
   path.
 
-* :gh:issue:`300`: the broker could crash on
+* :gh:issue:`300`: the broker could crash on OS X during shutdown due to
-  OS X during shutdown due to scheduled `kqueue
+  scheduled :freebsd:man2:`kqueue` filter changes for
-  <https://www.freebsd.org/cgi/man.cgi?query=kqueue>`_ filter changes for
   descriptors that were closed before the IO loop resumes. As a temporary
   workaround, kqueue's bulk change feature is not used.
 

docs/conf.py

@@ -1,10 +1,9 @@
-import os
 import sys
 
 sys.path.append('..')
 sys.path.append('.')
 import mitogen
-VERSION = '%s.%s.%s' % mitogen.__version__
+VERSION = '.'.join(str(part) for part in mitogen.__version__)
 
 author = u'Network Genomics'
 copyright = u'2021, the Mitogen authors'
@@ -44,15 +43,15 @@ version = VERSION
 domainrefs = {
     'gh:commit': {
         'text': '%s',
-        'url': 'https://github.com/dw/mitogen/commit/%s',
+        'url': 'https://github.com/mitogen-hq/mitogen/commit/%s',
     },
     'gh:issue': {
         'text': '#%s',
-        'url': 'https://github.com/dw/mitogen/issues/%s',
+        'url': 'https://github.com/mitogen-hq/mitogen/issues/%s',
     },
     'gh:pull': {
         'text': '#%s',
-        'url': 'https://github.com/dw/mitogen/pull/%s',
+        'url': 'https://github.com/mitogen-hq/mitogen/pull/%s',
     },
     'ans:mod': {
         'text': '%s module',
@@ -64,23 +63,23 @@ domainrefs = {
     },
     'freebsd:man2': {
         'text': '%s(2)',
-        'url': 'https://www.freebsd.org/cgi/man.cgi?query=%s',
+        'url': 'https://man.freebsd.org/cgi/man.cgi?query=%s',
     },
     'linux:man1': {
         'text': '%s(1)',
-        'url': 'http://man7.org/linux/man-pages/man1/%s.1.html',
+        'url': 'https://man7.org/linux/man-pages/man1/%s.1.html',
     },
     'linux:man2': {
         'text': '%s(2)',
-        'url': 'http://man7.org/linux/man-pages/man2/%s.2.html',
+        'url': 'https://man7.org/linux/man-pages/man2/%s.2.html',
     },
     'linux:man3': {
         'text': '%s(3)',
-        'url': 'http://man7.org/linux/man-pages/man3/%s.3.html',
+        'url': 'https://man7.org/linux/man-pages/man3/%s.3.html',
     },
     'linux:man7': {
         'text': '%s(7)',
-        'url': 'http://man7.org/linux/man-pages/man7/%s.7.html',
+        'url': 'https://man7.org/linux/man-pages/man7/%s.7.html',
     },
 }
 

docs/index.rst

@@ -26,7 +26,7 @@ and efficient low-level API on which tools like `Salt`_, `Ansible`_, or
 `Fabric`_ can be built, and while the API is quite friendly and comparable to
 `Fabric`_, ultimately it is not intended for direct use by consumer software.
 
-.. _Salt: https://docs.saltstack.com/en/latest/
+.. _Salt: https://docs.saltproject.io/en/latest/
 .. _Ansible: https://docs.ansible.com/
 .. _Fabric: https://www.fabfile.org/
 

docs/requirements.txt

@@ -1,3 +1,6 @@
+docutils<0.18
+Jinja2<3
+MarkupSafe<2.1
 Sphinx==2.1.2; python_version > '3.0'
 sphinxcontrib-programoutput==0.14; python_version > '3.0'
 alabaster==0.7.10; python_version > '3.0'

mitogen/parent.py

@@ -1027,7 +1027,7 @@ class KqueuePoller(mitogen.core.Poller):
 
 class EpollPoller(mitogen.core.Poller):
     """
-    Poller based on the Linux :linux:man2:`epoll` interface.
+    Poller based on the Linux :linux:man7:`epoll` interface.
     """
     SUPPORTED = hasattr(select, 'epoll')
     _repr = 'EpollPoller()'

mitogen/service.py

@@ -752,8 +752,10 @@ class PushFileService(Service):
         One size fits all method to ensure a target context has been preloaded
         with a set of small files and Python modules.
 
-        overridden_sources: optional dict containing source code to override path's source code
+        :param dict overridden_sources:
-        extra_sys_paths:    loads additional sys paths for use in finding modules; beneficial
+            Optional dict containing source code to override path's source code
+        :param extra_sys_paths:
+            Loads additional sys paths for use in finding modules; beneficial
             in situations like loading Ansible Collections because source code
             dependencies come from different file paths than where the source lives
         """

tox.ini

@@ -139,7 +139,9 @@ whitelist_externals =
     echo
 
 [testenv:docs]
-basepython = python3
+basepython = python3.8
 changedir = docs
 commands =
     sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
+deps =
+    -r docs/requirements.txt