From 1bee78837bec0df625c1b098666315929cd977c6 Mon Sep 17 00:00:00 2001 From: Guillermo Rodriguez Date: Mon, 31 Aug 2020 11:49:14 -0300 Subject: [PATCH] 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",