diff --git a/doc/source/conf.py b/doc/source/conf.py index 903456d..09d07f1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,6 +23,8 @@ import stormpy import stormpy.logic +import sphinx_bootstrap_theme + # -- General configuration ------------------------------------------------ @@ -54,7 +56,7 @@ master_doc = 'index' # General information about the project. project = 'stormpy' -copyright = '2016 Moves RWTH Aachen' +copyright = '2016--2017 Moves RWTH Aachen' author = 'Sebastian Junges, Matthias Volk' # The version info for the project you're documenting, acts as replacement for @@ -93,13 +95,78 @@ add_module_names = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'bizstyle' +html_theme = 'bootstrap' + +html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() # 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 = {} + +html_theme_options = { + # Navigation bar title. (Default: ``project`` value) + 'navbar_title': "Stormpy", + + # Tab name for entire site. (Default: "Site") + 'navbar_site_name': "Stormpy", + + # 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': [ + ("Storm", "http://stormchecker.org", True), + ("Github", "https://github.com/moves-rwth/stormpy", True) + ], + + # Render the next and previous page links in navbar. (Default: true) + 'navbar_sidebarrel': True, + + # Render the current pages TOC in the navbar. (Default: true) + 'navbar_pagenav': True, + + # 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 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". + 'bootswatch_theme': "united", + + # Choose Bootstrap version. + # Values: "3" (default) or "2" (in quotes) + 'bootstrap_version': "3", +} # 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/doc/source/index.rst b/doc/source/index.rst index 9b081c5..edfa65c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,12 +3,13 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Stormpy is a set of python bindings for the probabilistic model checker `storm `_. - - Stormpy Documentation =================================== + +Stormpy is a set of python bindings for the probabilistic model checker `storm `_. + + .. toctree:: :maxdepth: 2 :caption: Contents: