From 3536e73df79236b6cfa16f691e8c4a02d4f48595 Mon Sep 17 00:00:00 2001 From: Guillermo Rodriguez Date: Mon, 27 Jul 2020 23:34:58 -0300 Subject: [PATCH 1/4] Changed docs theme to typelog, also removed all mentions to trio-run-in-process. --- docs/conf.py | 18 +++++++++--------- docs/index.rst | 16 ++++------------ setup.py | 2 +- 3 files changed, 14 insertions(+), 22 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4610618..af278ea 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -54,7 +54,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'sphinx_typlog_theme' pygments_style = 'sphinx' @@ -65,16 +65,16 @@ html_theme_options = { 'description': 'A trionic "actor model"', 'github_user': 'goodboy', 'github_repo': 'tractor', - 'github_button': 'true', - 'github_banner': 'true', - 'page_width': '1080px', - 'fixed_sidebar': 'false', + # 'github_button': 'true', + # 'github_banner': 'true', + # 'page_width': '1080px', + # 'fixed_sidebar': 'false', # 'sidebar_width': '200px', - 'travis_button': 'true', -} -html_sidebars = { - "**": ["about.html", "relations.html", "searchbox.html"] + # 'travis_button': 'true', } +# html_sidebars = { +# "**": ["about.html", "relations.html", "searchbox.html"] +# } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/index.rst b/docs/index.rst index f2e5ad3..4f0dadb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -460,24 +460,16 @@ via a ``start_method`` kwarg to ``tractor.run()``. Currently the options available are: -- ``trio_run_in_process``: a ``trio``-native spawner from the `Ethereum community`_ +- ``trio``: a ``trio``-native spawner basically an async wrapper on ``subprocess`` - ``spawn``: one of the stdlib's ``multiprocessing`` `start methods`_ - ``forkserver``: a faster ``multiprocessing`` variant that is Unix only .. _start methods: https://docs.python.org/3.8/library/multiprocessing.html#contexts-and-start-methods -.. _Ethereum community : https://github.com/ethereum/trio-run-in-process -``trio-run-in-process`` -+++++++++++++++++++++++ -`trio-run-in-process`_ is a young "pure ``trio``" process spawner -which utilizes the native `trio subprocess APIs`_. It has shown great -reliability under testing for predictable teardown when launching -recursive pools of actors (multiple nurseries deep) and as such has been -chosen as the default backend on \*nix systems. - -.. _trio-run-in-process: https://github.com/ethereum/trio-run-in-process -.. _trio subprocess APIs : https://trio.readthedocs.io/en/stable/reference-io.html#spawning-subprocesses +``trio`` +++++++++ +The `trio` backend ofers a lightweight async wrapper to ``subprocess``, takes advantage of the ``trio.open_process`` API. ``multiprocessing`` diff --git a/setup.py b/setup.py index cca38cf..959ee66 100755 --- a/setup.py +++ b/setup.py @@ -39,7 +39,7 @@ setup( ], install_requires=[ 'msgpack', 'trio>0.8', 'async_generator', 'colorlog', 'wrapt', - 'trio_typing', + 'trio_typing', 'sphinx_typlog_theme' ], tests_require=['pytest'], python_requires=">=3.7", From 13de7991d96559a8ba5d007497b5c958808c0ca6 Mon Sep 17 00:00:00 2001 From: Guillermo Rodriguez Date: Mon, 27 Jul 2020 23:41:41 -0300 Subject: [PATCH 2/4] Add link to trio process spawning docs --- docs/index.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 4f0dadb..2c2a7be 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -469,7 +469,9 @@ Currently the options available are: ``trio`` ++++++++ -The `trio` backend ofers a lightweight async wrapper to ``subprocess``, takes advantage of the ``trio.open_process`` API. +The ``trio`` backend ofers a lightweight async wrapper to ``subprocess``, takes advantage of the ``trio.`` `open_process`_ API. + +.. _open_process: https://trio.readthedocs.io/en/stable/reference-io.html#spawning-subprocesses ``multiprocessing`` From 1bee78837bec0df625c1b098666315929cd977c6 Mon Sep 17 00:00:00 2001 From: Guillermo Rodriguez Date: Mon, 31 Aug 2020 11:49:14 -0300 Subject: [PATCH 3/4] Added logo, fixed github links and grammar issues --- docs/_static/tractor_logo_side.svg | 458 +++++++++++++++++++++++++++++ docs/conf.py | 20 +- docs/index.rst | 4 +- requirements-docs.txt | 2 + setup.py | 2 +- 5 files changed, 473 insertions(+), 13 deletions(-) create mode 100644 docs/_static/tractor_logo_side.svg create mode 100644 requirements-docs.txt diff --git a/docs/_static/tractor_logo_side.svg b/docs/_static/tractor_logo_side.svg new file mode 100644 index 0000000..24da8bb --- /dev/null +++ b/docs/_static/tractor_logo_side.svg @@ -0,0 +1,458 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/conf.py b/docs/conf.py index af278ea..ede4ad4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,19 +62,19 @@ pygments_style = 'sphinx' # further. For a list of options available for each theme, see the # documentation. html_theme_options = { - 'description': 'A trionic "actor model"', + 'logo': 'tractor_logo_side.svg', + 'description': 'Structured concurrent "actors"', 'github_user': 'goodboy', 'github_repo': 'tractor', - # 'github_button': 'true', - # 'github_banner': 'true', - # 'page_width': '1080px', - # 'fixed_sidebar': 'false', - # 'sidebar_width': '200px', - # 'travis_button': 'true', } -# html_sidebars = { -# "**": ["about.html", "relations.html", "searchbox.html"] -# } +html_sidebars = { + "**": [ + 'logo.html', + 'github.html', + 'relations.html', + 'searchbox.html' + ] +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/index.rst b/docs/index.rst index 2c2a7be..08e582b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -460,7 +460,7 @@ via a ``start_method`` kwarg to ``tractor.run()``. Currently the options available are: -- ``trio``: a ``trio``-native spawner basically an async wrapper on ``subprocess`` +- ``trio``: a ``trio``-native spawner which is an async wrapper around ``subprocess`` - ``spawn``: one of the stdlib's ``multiprocessing`` `start methods`_ - ``forkserver``: a faster ``multiprocessing`` variant that is Unix only @@ -469,7 +469,7 @@ Currently the options available are: ``trio`` ++++++++ -The ``trio`` backend ofers a lightweight async wrapper to ``subprocess``, takes advantage of the ``trio.`` `open_process`_ API. +The ``trio`` backend offers a lightweight async wrapper around the standard libraries ``subprocess`` and takes advantage of the ``trio.`` `open_process`_ API. .. _open_process: https://trio.readthedocs.io/en/stable/reference-io.html#spawning-subprocesses diff --git a/requirements-docs.txt b/requirements-docs.txt new file mode 100644 index 0000000..5c53ba7 --- /dev/null +++ b/requirements-docs.txt @@ -0,0 +1,2 @@ +sphinx +sphinx_typlog_theme \ No newline at end of file diff --git a/setup.py b/setup.py index 959ee66..24d4479 100755 --- a/setup.py +++ b/setup.py @@ -39,7 +39,7 @@ setup( ], install_requires=[ 'msgpack', 'trio>0.8', 'async_generator', 'colorlog', 'wrapt', - 'trio_typing', 'sphinx_typlog_theme' + 'trio_typing' ], tests_require=['pytest'], python_requires=">=3.7", From a6f7b0df7c64e8d3a5cce3bcca1ad22a042569c1 Mon Sep 17 00:00:00 2001 From: Guillermo Rodriguez Date: Mon, 31 Aug 2020 12:17:59 -0300 Subject: [PATCH 4/4] Small grammar fix --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 08e582b..f254eb0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -469,7 +469,7 @@ Currently the options available are: ``trio`` ++++++++ -The ``trio`` backend offers a lightweight async wrapper around the standard libraries ``subprocess`` and takes advantage of the ``trio.`` `open_process`_ API. +The ``trio`` backend offers a lightweight async wrapper around ``subprocess`` from the standard library and takes advantage of the ``trio.`` `open_process`_ API. .. _open_process: https://trio.readthedocs.io/en/stable/reference-io.html#spawning-subprocesses