Prepare repo for posting docs on gh-pages (faust-streaming#346)

* cleanup requirements and references to authors and changelog * update sphinx requirements * disable flake8 to minimize inconvenience for devleopers for now * change Signature import * update AUTHORS.md * use m2r2 and mdinclude * upgrade docs for new version of sphinx * create test branch for gh-pages * disable make build call * fix pages branch * disable building * correct inputs * specify inputs properly * add six to dependencies * change branch * add requirements.txt to docs.txt * try another approach * add test branch * update token permissions * add persist-credentials * update action versions * never mind * enable GITHUB TOKEN * enable contents:write * force for now * force for now * try deploy-pages * reorganize * remove sphinx-notes * fix path to Documentation * cleanup * revert title reformat * update all references from fauststreaming/latest to faust-stream.github.io * fix typos to faust-streaming * fix travis links * update release procedure on contributing.rst
FreeDemon · Sep 1, 2022 · d0894e1 · d0894e1
1 parent 85534ec
commit d0894e1
Show file tree

Hide file tree

Showing 22 changed files with 148 additions and 120 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,5 @@
 *Note*: Before submitting this pull request, please review our [contributing
-guidelines](https://fauststream.com/en/latest/contributing.html).
+guidelines](https://faust-streaming.github.io/faust/contributing.html).
 
 ## Description
 

diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -0,0 +1,39 @@
+name: Pages
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  build:
+    name: "Build docs"
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/setup-python@v4
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+    - name: "Install deps and build with Sphinx"
+      run: make docs
+    - name: "Upload artifacts"
+      uses: actions/upload-pages-artifact@v1
+      with:
+        # Upload built docs
+        path: "./Documentation"
+  deploy:
+    name: "Deploy docs"
+    needs: build
+    runs-on: ubuntu-latest
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+    - uses: actions/deploy-pages@v1
+      id: deployment
+      name: "Deploy to GitHub Pages"
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,19 +8,19 @@ repos:
       - id: end-of-file-fixer
       - id: check-added-large-files
 
-  - repo: local
-    hooks:
-    #   - id: black
-    #     name: black
-    #     stages: [commit]
-    #     language: system
-    #     entry: black
-    #     types: [python]
-    #     files: .*\.py$
-
-      - id: flake8
-        name: flake8
-        stages: [commit]
-        language: system
-        entry: flake8
-        types: [python]
+#  - repo: local
+#    hooks:
+#    #   - id: black
+#    #     name: black
+#    #     stages: [commit]
+#    #     language: system
+#    #     entry: black
+#    #     types: [python]
+#    #     files: .*\.py$
+#
+#      - id: flake8
+#        name: flake8
+#        stages: [commit]
+#        language: system
+#        entry: flake8
+#        types: [python]
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -12,47 +12,48 @@ The award for doing this in any significant capacity for one year or longer, is
 
 ## Contributors
 
-| Name                | Email                                 |
-|---------------------|---------------------------------------|
-| Allison Wang        | <allison.wang@robinhood.com>          |
-| Jamshed Vesuna      | <jamshed@robinhood.com>               |
-| Jaren Glover        | <jaren@robinhood.com>                 |
-| Jerry Li            | <jerry.li@robinhood.com>              |
-| Prithvi Narasimhan  | <narasimhan.prithvi@gmail.com>        |
-| Ruby Wang           | <ruby.wang@robinhood.com>             |
-| Shrey Kumar Shahi   | <shrey@robinhood.com>                 |
-| Mika Eloranta       | <mel@aiven.io>                        |
-| Omar Rayward        | <orayward@yahoo.com>                  |
-| Alexander Oberegger | <alexander.oberegger@smaxtec.com>     |
-| Matthew Stump       | <mstump@vorstella.com>                |
-| Martin Maillard     | <self@martin-maillard.com>            |
-| Mattias Karlsson    | <mattias@hemmabolan.se>               |
-| Matthias Wutte      | <matthias.wutte@smaxtec.com>          |
-| Thibault Serot      | <thibserot@gmail.com>                 |
-| Ryan Whitten        | <ryan@pixability.com>                 |
-| Nimi Wariboko Jr    | <nimiwaribokoj@gmail.com>             |
-| Chris Seto          | <chriskseto@gmail.com>                |
-| Amit Ripshtos       | <amit.r@qspark.prod>                  |
-|  Miha Troha         | <miha.troha@comcom.si>                |
-|  Perk Lim           | <perk@robinhood.com>                  |
-| Julien Surloppe     | <julien@surloppe.fr>                  |
-| Bob Haddleton       | <bob.haddleton@nokia.com>             |
-| Nimish Telang       | <nimish@telang.net>                   |
-| Cesar Pantoja       | <cesarpantoj@gmail.com>               |
-| Tomasz Nguyen       | <me@swistofon.pl>                     |
-| Artak Papikyan      | <artakp@patriot1tech.com>             |
-| Andrei Tuppitcyn    | <andrew.tupitsin@gmail.com>           |
-| Vikram Patki        | <vpatki@wayfair.com>                  |
-| Victor Miroshnikov  | <me@vmiroshnikov.com>                 |
-| Tobias Rauter       | <tobias.rauter@smaxtec.com>           |
-| DhruvaPatil98       | <dhruva.patil@galepartners.com>       |
-| Leandro Vonwerra    | <leandro.vonwerra@spoud.io>           |
-| Ignacio Peluffo     | <ipeluffo@gmail.com>                  |
-| Sergej Herbert      | <herbert.sergej@gmail.com>            |
-| Marcos Schroh       | <schrohm@gmail.com>                   |
-| Denis Kovalev       | <aikikode@gmail.com>                  |
-| Jonathan A. Booth   | <jonathan.booth@mastery.net>          |
-| Eran Kampf          | <ekampf@users.noreply.github.com>     |
-| Wjatscheslaw Kewlin | <Wjatscheslaw.Kewlin@d-fine.de>       |
-| Ramkumar M          | <ramchiyan1093@gmail.com>             |
-| Mark Lambert        | <mark.lambert@gmail.com>              |
+| Name                | Email                             |
+|---------------------|-----------------------------------|
+| Allison Wang        | <allison.wang@robinhood.com>      |
+| Jamshed Vesuna      | <jamshed@robinhood.com>           |
+| Jaren Glover        | <jaren@robinhood.com>             |
+| Jerry Li            | <jerry.li@robinhood.com>          |
+| Prithvi Narasimhan  | <narasimhan.prithvi@gmail.com>    |
+| Ruby Wang           | <ruby.wang@robinhood.com>         |
+| Shrey Kumar Shahi   | <shrey@robinhood.com>             |
+| Mika Eloranta       | <mel@aiven.io>                    |
+| Omar Rayward        | <orayward@yahoo.com>              |
+| Alexander Oberegger | <alexander.oberegger@smaxtec.com> |
+| Matthew Stump       | <mstump@vorstella.com>            |
+| Martin Maillard     | <self@martin-maillard.com>        |
+| Mattias Karlsson    | <mattias@hemmabolan.se>           |
+| Matthias Wutte      | <matthias.wutte@smaxtec.com>      |
+| Thibault Serot      | <thibserot@gmail.com>             |
+| Ryan Whitten        | <ryan@pixability.com>             |
+| Nimi Wariboko Jr    | <nimiwaribokoj@gmail.com>         |
+| Chris Seto          | <chriskseto@gmail.com>            |
+| Amit Ripshtos       | <amit.r@qspark.prod>              |
+| Miha Troha          | <miha.troha@comcom.si>            |
+| Perk Lim            | <perk@robinhood.com>              |
+| Julien Surloppe     | <julien@surloppe.fr>              |
+| Bob Haddleton       | <bob.haddleton@nokia.com>         |
+| Nimish Telang       | <nimish@telang.net>               |
+| Cesar Pantoja       | <cesarpantoj@gmail.com>           |
+| Tomasz Nguyen       | <me@swistofon.pl>                 |
+| Artak Papikyan      | <artakp@patriot1tech.com>         |
+| Andrei Tuppitcyn    | <andrew.tupitsin@gmail.com>       |
+| Vikram Patki        | <vpatki@wayfair.com>              |
+| Victor Miroshnikov  | <me@vmiroshnikov.com>             |
+| Tobias Rauter       | <tobias.rauter@smaxtec.com>       |
+| DhruvaPatil98       | <dhruva.patil@galepartners.com>   |
+| Leandro Vonwerra    | <leandro.vonwerra@spoud.io>       |
+| Ignacio Peluffo     | <ipeluffo@gmail.com>              |
+| Sergej Herbert      | <herbert.sergej@gmail.com>        |
+| Marcos Schroh       | <schrohm@gmail.com>               |
+| Denis Kovalev       | <aikikode@gmail.com>              |
+| Jonathan A. Booth   | <jonathan.booth@mastery.net>      |
+| Eran Kampf          | <ekampf@users.noreply.github.com> |
+| Wjatscheslaw Kewlin | <Wjatscheslaw.Kewlin@d-fine.de>   |
+| Ramkumar M          | <ramchiyan1093@gmail.com>         |
+| Mark Lambert        | <mark.lambert@gmail.com>          |
+| William Barnhart    | <williambbarnhart@gmail.com>      |
diff --git a/README.md b/README.md
@@ -2,8 +2,8 @@
 
 # Python Stream Processing Fork
 
-![python versions](https://img.shields.io/badge/python-3.6%203.7%203.8%203.9-blue)
-![version](https://img.shields.io/badge/version-0.6.9-green)
+![python versions](https://img.shields.io/badge/python-3.6%203.7%203.8%203.9%203.10-blue)
+![version](https://img.shields.io/badge/version-0.8.8-green)
 [![codecov](https://codecov.io/gh/faust-streaming/faust/branch/master/graph/badge.svg?token=QJFBYNN0JJ)](https://codecov.io/gh/faust-streaming/faust)
 
 ## Installation
@@ -12,9 +12,9 @@
 
 ## Documentation
 
-- `introduction`: https://fauststream.com/en/latest/introduction.html
-- `quickstart`: https://fauststream.com/en/latest/playbooks/quickstart.html
-- `User Guide`: https://fauststream.com/en/latest/userguide/index.html
+- `introduction`: https://faust-streaming.github.io/faust/introduction.html
+- `quickstart`: https://faust-streaming.github.io/faust/playbooks/quickstart.html
+- `User Guide`: https://faust-streaming.github.io/faust/userguide/index.html
 
 ## Why the fork
 
@@ -285,7 +285,7 @@ Aerospike can be enabled as the state store by specifying
 
 By default, all tables backed by Aerospike use `use_partitioner=True` and generate changelog topic events similar
 to a state store backed by RocksDB.
-The following configuration options should be passed in as keys to the options parameter in [Table](https://fauststream.com/en/latest/reference/faust.tables.html)
+The following configuration options should be passed in as keys to the options parameter in [Table](https://faust-streaming.github.io/faust/reference/faust.tables.html)
 `namespace` : aerospike namespace
 
 `ttl`: TTL for all KV's in the table
@@ -407,14 +407,14 @@ introduced in Python 3.6 (`async`, `await`, variable type annotations).
 
 ### I get a maximum number of open files exceeded error by RocksDB when running a Faust app locally. How can I fix this
 
-You may need to increase the limit for the maximum number of open files. 
-On macOS and Linux you can use: 
+You may need to increase the limit for the maximum number of open files.
+On macOS and Linux you can use:
 
 ```ulimit -n max_open_files``` to increase the open files limit to max_open_files.
 
 On docker, you can use the --ulimit flag:
 
-```docker run --ulimit nofile=50000:100000 <image-tag>``` 
+```docker run --ulimit nofile=50000:100000 <image-tag>```
 where 50000 is the soft limit, and 100000 is the hard limit [See the difference](https://unix.stackexchange.com/a/29579).
 
 ### What kafka versions faust supports

diff --git a/docs/_ext/typehints.py b/docs/_ext/typehints.py
@@ -1,6 +1,9 @@
 import inspect
 from typing import Any, AnyStr, TypeVar, get_type_hints
-from sphinx.util.inspect import Signature
+try:
+    from sphinx.ext.autodoc import Signature
+except ImportError:
+    from sphinx.util.inspect import signature as Signature
 
 try:
     from typing import GenericMeta  # Py3.7
@@ -124,7 +127,8 @@ def process_docstring(app, what, name, obj, options, lines):
         obj = inspect.unwrap(obj)
         try:
             type_hints = get_type_hints(obj)
-        except (AttributeError, TypeError):
+        # except (AttributeError, TypeError):
+        except:  # FIXME: A new exception is being raised, likely due to upgrading sphinx
             # Introspecting a slot wrapper will raise TypeError
             return
 

diff --git a/docs/authors.rst b/docs/authors.rst
@@ -7,4 +7,4 @@
 .. contents::
     :local:
 
-.. include:: ../AUTHORS.rst
+.. mdinclude:: ../AUTHORS.md
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1 +1 @@
-.. include:: ../Changelog.rst
+.. mdinclude:: ../CHANGELOG.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -11,10 +11,10 @@
     project='Faust',
     version_dev='1.1',
     version_stable='1.0',
-    canonical_url='https://fauststream.com/en/latest',
+    canonical_url='https://faust-streaming.github.io/faust',
     webdomain='',
     github_project='faust-streaming/faust',
-    copyright='2017-2020, 2022 Community',
+    copyright='2017-2020, 2021-2022 Community',
     html_logo='images/logo.png',
     html_favicon='images/favicon.ico',
     html_prepend_sidebars=[],
@@ -24,6 +24,7 @@
         'alabaster',
         'typehints',
         'faustdocs',
+        'm2r2',
     ],
     extra_intersphinx_mapping={
         'aiohttp': ('https://aiohttp.readthedocs.io/en/stable/', None),

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -795,16 +795,16 @@ Packages
 ---------
 
 :git: https://github.com/faust-streaming/faust
-:CI: http://travis-ci.org/#!/robinhood/faust
+:CI: https://app.travis-ci.com/github/faust-streaming/faust
 :Windows-CI: https://ci.appveyor.com/project/ask/faust
 :PyPI: :pypi:`faust-streaming`
-:docs: https://fauststream.com/en/latest/
+:docs: https://faust-streaming.github.io/faust/
 
 ``Mode``
 --------
 
 :git: https://github.com/faust-streaming/mode/
-:CI: https://www.travis-ci.com/#!/faust-streaming/mode
+:CI: https://www.travis-ci.com/github/faust-streaming/mode
 :Windows-CI: https://ci.appveyor.com/project/faust-streaming/mode
 :PyPI: :pypi:`mode-streaming`
 :docs: http://mode.readthedocs.io/
@@ -847,24 +847,5 @@ and make a new version tag:
 Releasing
 ---------
 
-Commands to make a new public stable release:
-
-.. sourcecode:: console
-
-    $ make distcheck  # checks pep8, autodoc index, runs tests and more
-    $ make dist  # NOTE: Runs git clean -xdf and removes files not in the repo.
-    $ python setup.py sdist upload --sign --identity='Celery Security Team'
-    $ python setup.py bdist_wheel upload --sign --identity='Celery Security Team'
-
-If this is a new release series then you also need to do the
-following:
-
-* Go to the Read The Docs management interface at:
-    http://readthedocs.org/projects/faust/?fromdocs=faust
-
-* Enter "Edit project"
-
-    Change default branch to the branch of this series, for example, use
-    the ``1.0`` branch for the 1.0 series.
-
-* Also add the previous version under the "versions" tab.
+This is all done automatically on GitHub when a release
+is tagged in https://github.com/faust-streaming/faust/releases.
diff --git a/docs/includes/resources.txt b/docs/includes/resources.txt
@@ -9,9 +9,8 @@ Slack
 -----
 
 For discussions about the usage, development, and future of Faust,
-please join the `fauststream`_ Slack.
+please join the faust-streaming Slack at https://fauststream.slack.com.
 
-* https://fauststream.slack.com
 * Sign-up: https://join.slack.com/t/fauststream/shared_invite/enQtNDEzMTIyMTUyNzU2LTIyMjNjY2M2YzA2OWFhMDlmMzVkODk3YTBlYThlYmZiNTUwZDJlYWZiZTdkN2Q4ZGU4NWM4YWMyNTM5MGQ5OTg
 
 Resources

diff --git a/docs/includes/settingref.txt b/docs/includes/settingref.txt
@@ -128,7 +128,7 @@ The value for this argument can be:
 :type: :class:`str` / :class:`~pathlib.Path`
 :default: ``'{conf.name}-data'``
 :environment: :envvar:`APP_DATADIR`
-:related-command-options: :option:`faust -`, :option:`faust -`, :option:`faust d`, :option:`faust a`, :option:`faust t`, :option:`faust a`, :option:`faust d`, :option:`faust i`, :option:`faust r`
+:related-command-options: :option:`faust --data-dir`
 
 Application data directory.
 
@@ -171,7 +171,7 @@ setting.
 :type: :class:`bool`
 :default: :const:`False`
 :environment: :envvar:`APP_DEBUG`
-:related-command-options: :option:`faust -`, :option:`faust -`, :option:`faust d`, :option:`faust e`, :option:`faust b`, :option:`faust u`, :option:`faust g`
+:related-command-options: :option:`faust --debug`
 
 Use in development to expose sensor information endpoint.
 
@@ -290,7 +290,7 @@ the second version is 2, and so on.
 :type: :class:`float` / :class:`~datetime.timedelta`
 :default: :const:`None`
 :environment: :envvar:`BLOCKING_TIMEOUT`
-:related-command-options: :option:`faust -`, :option:`faust -`, :option:`faust b`, :option:`faust l`, :option:`faust o`, :option:`faust c`, :option:`faust k`, :option:`faust i`, :option:`faust n`, :option:`faust g`, :option:`faust -`, :option:`faust t`, :option:`faust i`, :option:`faust m`, :option:`faust e`, :option:`faust o`, :option:`faust u`, :option:`faust t`
+:related-command-options: :option:`faust --blocking-timeout`
 
 Blocking timeout (in seconds).
 
@@ -1829,7 +1829,7 @@ not by passing it as a keyword argument to :class:`app`.
 
 :type: :class:`str` / :class:`~yarl.URL`
 :default: ``URL('tcp:')``
-:related-command-options: :option:`faust worker --web-transport`
+:related-command-options:  :option:`faust worker --web-transport`
 
 Network transport used for the web server.
 
@@ -2370,6 +2370,3 @@ Example using a class::
 Example using the string path to a class::
 
    app = faust.App(..., Monitor='myproj.monitors.Monitor')
-
-
-
diff --git a/docs/includes/tags.txt b/docs/includes/tags.txt
@@ -1,6 +1,5 @@
 :Version: 1.10.4
-:Web: https://fauststream.com/en/latest
+:Web: https://faust-streaming.github.io/faust
 :Download: http://pypi.org/project/faust
 :Source: http://github.com/faust-streaming/faust
 :Keywords: distributed, stream, async, processing, data, queue, state management
-
diff --git a/docs/templates/readme.txt b/docs/templates/readme.txt
@@ -42,7 +42,7 @@ Be sure to also read the `Contributing to Faust`_ section in the
 documentation.
 
 .. _`Contributing to Faust`:
-    https://fauststream.com/en/latest/contributing.html
+    https://faust-streaming.github.io/faust/contributing.html
 
 .. include:: ../includes/code-of-conduct.txt
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		.. include:: ../Changelog.rst
		.. mdinclude:: ../CHANGELOG.md