Skip to content

Commit

Permalink
Attempt configuring sphinx-book-theme
Browse files Browse the repository at this point in the history
  • Loading branch information
goodboy committed May 31, 2021
1 parent 7726c91 commit d9a1822
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 14 deletions.
21 changes: 13 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,26 @@
#
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
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
# 'logo': 'tractor_logo_side.svg',
# 'description': 'Structured concurrent "actors"',
'repository_url': "https://github.com/goodboy/tractor",
'use_repository_button': True,
"repository_url": "https://github.com/goodboy/tractor",
"use_repository_button": True,
"home_page_in_toc": False,
"show_toc_level": 1,
"path_to_docs": "docs",

}
html_sidebars = {
"**": [
'globaltoc.html',
'sbt-sidebar-nav.html',
"sbt-sidebar-nav.html",
"sidebar-search-bs.html",
# 'localtoc.html',
],
# 'logo.html',
# 'github.html',
Expand All @@ -80,12 +85,12 @@
}

# 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_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,
# relative to this directory. They are copied after the builtin static files,
Expand Down
9 changes: 4 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
tractor
=======
``tractor``
===========

A `structured concurrent`_, async-native "`actor model`_" built on trio_ and multiprocessing_.

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Contents:

.. _actor model: https://en.wikipedia.org/wiki/Actor_model
Expand Down Expand Up @@ -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


.. contents::


Philosophy
----------
Expand Down
2 changes: 1 addition & 1 deletion requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
sphinx
sphinx_typlog_theme
sphinx_book_theme

0 comments on commit d9a1822

Please sign in to comment.