Changed docs theme to typelog, also removed all mentions to trio-run-in-process.

matrix
Guillermo Rodriguez 2020-07-27 23:34:58 -03:00
parent 4da16325f3
commit 3536e73df7
No known key found for this signature in database
GPG Key ID: 3F61096EC7DF75A8
3 changed files with 14 additions and 22 deletions

View File

@ -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,

View File

@ -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``

View File

@ -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",