html_static_path = ["_static"] # -- Sphinx-multiversion config ---------------------------------------------- # which branches to include in multi-versioned docs # - master, develop and vX.X branches smv_branch_whitelist = r"^master$|^develop$|^v[0-9\.]+?$" smv_outputdir_format = "{config.release}" # don't make docs for tags smv_tag_whitelist = r"^$" # -- Options for HTML output ------------------------------------------------- # html_theme = "alabaster" html_theme = "stanford_theme" html_theme_path = [sphinx_theme.get_html_theme_path("stanford_theme")] # Custom extras for sidebar html_sidebars = { "**": [ "searchbox.html", "localtoc.html", # "globaltoc.html", "relations.html", "sourcelink.html", "versioning.html", ] } html_favicon = "_static/favicon.ico" # HTML syntax highlighting style
# Configuration for autodoc/summary autoclass_content = "both" # include both class docstring and __init__ autodoc_default_flags = [ # Make sure that any autodoc declarations show the right members "members", "inherited-members", "show-inheritance", ] autosummary_generate = True autodoc_member_order = 'groupwise' add_module_names = False # Todo configuration todo_include_todos = True # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # # html_theme = 'classic' # html_theme = 'alabaster' html_theme = "stanford_theme" html_theme_path = [sphinx_theme.get_html_theme_path('stanford-theme')] # 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, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static']
# -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. # extensions = ['sphinx.ext.autodoc'] extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = "neo_rtd_theme" html_theme_path = [sphinx_theme.get_html_theme_path(html_theme)] # 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, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = [] autoclass_content = "both"
# -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ["sphinx.ext.autodoc"] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [] # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # import sphinx_theme html_theme = "neo_rtd_theme" html_theme_path = [sphinx_theme.get_html_theme_path('neo_rtd_theme')] # 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, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] add_module_names = False
# List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'neo_rtd_theme' html_theme_path = [theme.get_html_theme_path('neo_rtd_theme')] html_logo = 'logo.png' # 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. # # sphinx_rtd_theme options: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#theme-options # html_theme_options = {} html_context = { 'display_github': True, 'github_user': '******', 'github_repo': 'PIGO', 'github_version': 'master', 'conf_py_path': '/docs/' }
# -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # 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 = {} # Add any paths that contain custom themes here, relative to this directory. try: import sphinx_theme html_theme = 'neo_rtd_theme' html_theme_path = [ sphinx_theme.get_html_theme_path() ] html_theme_options = { 'collapse_navigation': False, 'display_version': False, 'navigation_depth': 3, } except: html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None
# The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # # Adde by YT import sphinx_theme html_theme = "neo_rtd_theme" html_theme_path = [sphinx_theme.get_html_theme_path('neo_rtd_theme')] #html_theme = 'alabaster' # 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 = {} # 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, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # -- Options for HTMLHelp output ------------------------------------------