diff --git a/docs/source/conf.py b/docs/source/conf.py index 4b57f55..5cf7b3d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -53,98 +53,27 @@ def setup(app): # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -# html_theme = "furo" -# conf.py -# ... - # Activate the theme. -html_theme = 'bootstrap' -html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() - -# (Optional) Logo. Should be small enough to fit the navbar (ideally 24x24). -# Path should be relative to the ``_static`` files directory. -# html_logo = "my_logo.png" - -# Theme options are theme-specific and customize the look and feel of a -# theme further. -html_theme_options = { - # Navigation bar title. (Default: ``project`` value) - 'navbar_title': "python-template", - - # Tab name for entire site. (Default: "Site") - - 'navbar_site_name': "Site", - - # A list of tuples containing pages or urls to link to. - # Valid tuples should be in the following forms: - # (name, page) # a link to a page - # (name, "/aa/bb", 1) # a link to an arbitrary relative url - # (name, "http://example.com", True) # arbitrary absolute url - # Note the "1" or "True" value above as the third argument to indicate - # an arbitrary url. - 'navbar_links': [ - ("Quickstart", "quickstart"), - ("Tutorials", "tutorial"), - ("API", "api"), - # ("Link", "http://example.com", True), - ], +html_theme = "sphinx_book_theme" - # Render the next and previous page links in navbar. (Default: true) - 'navbar_sidebarrel': False, - - # Render the current pages TOC in the navbar. (Default: true) - 'navbar_pagenav': False, - - # Tab name for the current pages TOC. (Default: "Page") - 'navbar_pagenav_name': "Page", - - # Global TOC depth for "site" navbar tab. (Default: 1) - # Switching to -1 shows all levels. - 'globaltoc_depth': 2, - - # Include hidden TOCs in Site navbar? - # - # Note: If this is "false", you cannot have mixed ``:hidden:`` and - # non-hidden ``toctree`` directives in the same page, or else the build - # will break. - # - # Values: "true" (default) or "false" - 'globaltoc_includehidden': "true", - - # HTML navbar class (Default: "navbar") to attach to
element. - # For black navbar, do "navbar navbar-inverse" - 'navbar_class': "navbar inverse", - - # Fix navigation bar to top of page? - # Values: "true" (default) or "false" - 'navbar_fixed_top': "true", - - # Location of link to source. - # Options are "nav" (default), "footer" or anything else to exclude. - 'source_link_position': "footer", - - # Bootswatch (http://bootswatch.com/) theme. - # - # Options are nothing (default) or the name of a valid theme - # such as "cosmo" or "sandstone". - # - # The set of valid themes depend on the version of Bootstrap - # that's used (the next config option). - # - # Currently, the supported themes are: - # - Bootstrap 2: https://bootswatch.com/2 - # - Bootstrap 3: https://bootswatch.com/3 - 'bootswatch_theme': "flatly", - - # Choose Bootstrap version. - # Values: "3" (default) or "2" (in quotes) - 'bootstrap_version': "3", -} html_static_path = ["_static"] -templates_path = ['_templates'] +templates_path = ["_templates"] + +# html_sidebars = {"**": []} -html_sidebars = { - '**': [] +html_theme_options = { + "repository_branch": "devel", + "show_toc_level": 3, + "secondary_sidebar_items": ["page-toc"], + "icon_links": [ + { + "name": "GitHub", + "url": "https://github.com/max-models/template-python", + "icon": "fab fa-github", + "type": "fontawesome", + }, + ], } +