goodboy
/
tractor
1
0
Fork 1
Code Issues 1 Pull Requests 4 Packages Projects Releases Wiki Activity

Attempt configuring sphinx-book-theme

new_docs_polish
Tyler Goodlet 2021-02-28 20:40:44 -05:00
parent fb23a9d8d4
commit 5528a4eb45
3 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/conf.py
View File

@ -56,7 +56,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# #
html_theme = 'sphinx_book_theme' html_theme = 'sphinx_book_theme'
pygments_style = 'sphinx' pygments_style = 'algol_nu'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
@ -64,13 +64,18 @@ pygments_style = 'sphinx'
html_theme_options = { html_theme_options = {
# 'logo': 'tractor_logo_side.svg', # 'logo': 'tractor_logo_side.svg',
# 'description': 'Structured concurrent "actors"', # 'description': 'Structured concurrent "actors"',
'repository_url': "https://github.com/goodboy/tractor", "repository_url": "https://github.com/goodboy/tractor",
'use_repository_button': True, "use_repository_button": True,
"home_page_in_toc": False,
"show_toc_level": 1,
"path_to_docs": "docs",
} }
html_sidebars = { html_sidebars = {
"**": [ "**": [
'globaltoc.html', "sbt-sidebar-nav.html",
'sbt-sidebar-nav.html', "sidebar-search-bs.html",
# 'localtoc.html',
], ],
# 'logo.html', # 'logo.html',
# 'github.html', # 'github.html',
@ -80,12 +85,12 @@ html_sidebars = {
} }
# doesn't seem to work? # doesn't seem to work?
extra_navbar = "<p>nextttt-gennnnn</p>" # extra_navbar = "<p>nextttt-gennnnn</p>"
html_title = 'tractor' html_title = ''
html_logo = '_static/tractor_logo_side.svg' html_logo = '_static/tractor_logo_side.svg'
html_favicon = '_static/tractor_logo_side.svg' html_favicon = '_static/tractor_logo_side.svg'
show_navbar_depth = 1 # show_navbar_depth = 1
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,

9
docs/index.rst
View File

@ -3,12 +3,13 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
tractor ``tractor``
======= ===========
A `structured concurrent`_, async-native "`actor model`_" built on trio_ and multiprocessing_. A `structured concurrent`_, async-native "`actor model`_" built on trio_ and multiprocessing_.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Contents: :caption: Contents:
.. _actor model: https://en.wikipedia.org/wiki/Actor_model .. _actor model: https://en.wikipedia.org/wiki/Actor_model
@ -58,8 +59,6 @@ say hi, please feel free to ping me on the `trio gitter channel`_!
.. _trio gitter channel: https://gitter.im/python-trio/general .. _trio gitter channel: https://gitter.im/python-trio/general
.. contents::
Philosophy Philosophy
---------- ----------

2
requirements-docs.txt
View File

@ -1,2 +1,2 @@
sphinx sphinx
sphinx_typlog_theme sphinx_book_theme