def load_extra_theme(cls, name): themes = ['alabaster'] try: import sphinx_rtd_theme themes.append('sphinx_rtd_theme') except ImportError: pass if name in themes: if name == 'alabaster': import alabaster themedir = alabaster.get_path() # alabaster theme also requires 'alabaster' extension, it will be loaded # at sphinx.application module. elif name == 'sphinx_rtd_theme': themedir = sphinx_rtd_theme.get_html_theme_path() else: raise NotImplementedError('Programming Error') else: for themedir in load_theme_plugins(): if path.isfile(path.join(themedir, name, THEMECONF)): break else: # specified theme is not found return cls.themepath.append(themedir) cls.themes[name] = (path.join(themedir, name), None) return
def load_sphinx_rtd_theme(self): # type: () -> None """Load sphinx_rtd_theme theme (if exists).""" try: import sphinx_rtd_theme theme_path = sphinx_rtd_theme.get_html_theme_path() self.themes['sphinx_rtd_theme'] = path.join(theme_path, 'sphinx_rtd_theme') except ImportError: pass
def set_sphinx_html_path(project): import sphinx_rtd_theme sphinx_conf = project.get_property("sphinx_project_conf") sphinx_conf["html_theme"] = "sphinx_rtd_theme" sphinx_conf["html_theme_path"] = [sphinx_rtd_theme.get_html_theme_path()] # Napoleon settings sphinx_conf["extensions"].append("sphinx.ext.napoleon") sphinx_conf["napoleon_google_docstring"] = True sphinx_conf["napoleon_numpy_docstring"] = False sphinx_conf["napoleon_include_init_with_doc"] = False sphinx_conf["napoleon_include_private_with_doc"] = False sphinx_conf["napoleon_include_special_with_doc"] = False sphinx_conf["napoleon_use_admonition_for_examples"] = False sphinx_conf["napoleon_use_admonition_for_notes"] = False sphinx_conf["napoleon_use_admonition_for_references"] = False sphinx_conf["napoleon_use_ivar"] = False sphinx_conf["napoleon_use_param"] = True sphinx_conf["napoleon_use_rtype"] = True sphinx_conf["napoleon_use_keyword"] = True
def set_theme(name): global html_theme global html_theme_path if name == 'nature': html_theme = 'nature' elif name == 'rtd': import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] elif name == 'pyramid': # TODO: broken? import pylons_sphinx_themes html_theme = 'pyramid' html_theme_path = [pylons_sphinx_themes.get_html_themes_path()] elif name == 'adc': import sphinx_adc_theme html_theme = 'sphinx_adc_theme' html_theme_path = [sphinx_adc_theme.get_html_theme_path()] # elif name == 'jupyter': # # TODO: should be on top of file? # from jupyter_sphinx_theme import * # init_theme() elif name == 'celery': import sphinx_celery html_theme = 'sphinx_celery' html_theme_path = [sphinx_celery.get_html_theme_path()] elif name == 'material': import sphinx_theme_pd html_theme = 'sphinx_theme_pd' html_theme_path = [sphinx_theme_pd.get_html_theme_path()] elif name == 'plone': extensions.append('sphinxjp.themecore') html_theme = 'plonetheme' elif name == 'mdn': import mdn_theme html_theme_path = [mdn_theme.get_theme_dir()] html_theme = 'mdn' else: raise Exception('Unknown theme {}'.format(name))
def load_extra_theme(cls, name): if name == 'alabaster': cls.themes[name] = (os.path.join(alabaster.get_path(), name), None) # alabaster theme also requires 'alabaster' extension, it will be loaded at # sphinx.******* module. return if name == 'sphinx_rtd_theme': cls.themes[name] = ( os.path.join(sphinx_rtd_theme.get_html_theme_path(), name), None) return for themedir in load_theme_plugins(): if not path.isdir(themedir): continue for theme in os.listdir(themedir): if theme != name: continue if not path.isfile(path.join(themedir, theme, THEMECONF)): continue cls.themes[theme] = (path.join(themedir, theme), None) return
def load_extra_theme(cls, name): if name in ("alabaster", "sphinx_rtd_theme"): if name == "alabaster": themedir = alabaster.get_path() # alabaster theme also requires 'alabaster' extension, it will be loaded # at sphinx.application module. elif name == "sphinx_rtd_theme": themedir = sphinx_rtd_theme.get_html_theme_path() else: raise NotImplementedError("Programming Error") else: for themedir in load_theme_plugins(): if path.isfile(path.join(themedir, name, THEMECONF)): break else: # specified theme is not found return cls.themepath.append(themedir) cls.themes[name] = (path.join(themedir, name), None) return
""" Options for sphinx Add project specific options to conf.py in the root folder """ import sphinx_rtd_theme import os this_dir = os.path.abspath(os.path.dirname(__file__)) support_dir = os.path.join(this_dir, "..", "support") extensions = ['sphinx.ext.autodoc'] html_theme = 'the_theme' html_theme_path = [os.path.join(support_dir, 'templates'), sphinx_rtd_theme.get_html_theme_path()] html_static_path = [os.path.join(support_dir, "static"), os.path.join(sphinx_rtd_theme.get_html_theme_path(), "sphinx_rtd_theme", "static")] exclude_patterns = [] master_doc = 'index' source_suffix = '.rst' pygments_style = 'pastie' # Add options specific to this project location = os.path.join(this_dir, '../conf.py') with open(location) as f: code = compile(f.read(), location, 'exec') exec(code, globals(), locals())
extensions = ['sphinxcontrib.phpdomain'] templates_path = ['_templates'] source_suffix = '.rst' master_doc = 'index' project = u'php-opencloud' copyright = u'2015, Jamie Hannaford, Shaunak Kashyap' version = '1.12' release = '1.12.1' exclude_patterns = ['_build'] pygments_style = 'sphinx' html_theme = 'default' if not on_rtd: import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "_templates"] html_static_path = ['_static'] html_use_index = True # Output file base name for HTML help builder. htmlhelp_basename = 'php-openclouddoc' latex_documents = [ ('index', 'php-opencloud.tex', u'php-opencloud Documentation', u'Jamie Hannaford, Shaunak Kashyap', 'manual'), ] man_pages = [ ('index', 'php-opencloud', u'php-opencloud Documentation', [u'Jamie Hannaford, Shaunak Kashyap'], 1)
""" Options for sphinx Add project specific options to conf.py in the root folder """ import sys, os import sphinx_rtd_theme this_dir = os.path.abspath(os.path.dirname(__file__)) extension_dir = os.path.join(this_dir, "ext") sys.path.extend([extension_dir]) extensions = ['show_specs', 'show_tasks'] html_theme = 'the_theme' html_theme_path = [os.path.join(this_dir, 'templates'), sphinx_rtd_theme.get_html_theme_path()] html_static_path = [os.path.join(this_dir, "static")] exclude_patterns = ["_build/**", "ext/**", "venv/**"] master_doc = 'index' source_suffix = '.rst' pygments_style = 'pastie' # Add options specific to this project with open(os.path.join(this_dir, "../conf.py")) as f: code = compile(f.read(), os.path.join(this_dir, "../conf.py"), 'exec') exec(code, globals(), locals())
exclude_patterns = [] templates_path = ['_templates'] extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax'] source_suffix = '.rst' master_doc = 'index' pygments_style = 'sphinx' highlight_language = 'cpp' todo_include_todos = True # # HTML output options # html_theme = 'sphinx_rtd_theme' html_theme_path = [theme.get_html_theme_path()] # Add any paths that contain custom static files (such as stylesheets) 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'] # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. html_use_smartypants = True # If true, links to the reST sources are added to the pages. html_show_sourcelink = True
# List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build', 'themes', 'README.rst', 'global.rst'] # 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 = False # -- Options for HTML output ---------------------------------------------- import sphinx_rtd_theme html_theme = 'sheffieldhpc' html_theme_path = ['themes'] + [sphinx_rtd_theme.get_html_theme_path()] html_theme_options = { 'style_external_links': True, 'canonical_url': 'https://docs.hpc.sheffield.ac.uk', 'navigation_depth': 6, } # html_theme_options = {'navbar_sidebarrel':False, # 'navbar_pagenav': False, # 'source_link_position': False, # 'bootswatch_theme': 'flatly', # 'navbar_site_name': "Sheffield HPC Documentation", # 'navbar_title': ' ', # 'navbar_links': [ # ("Home", "index"), # ("Research Computing @ IT Services", "https://www.shef.ac.uk/it-services/research", True),
highlight_language = "julia" # -- 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 = "julia" # 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. html_theme_path = [juliadoc.get_theme_dir(), sphinx_rtd_theme.get_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 an image file (relative to this directory) to place at the top # of the sidebar. # html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large.
#modindex_common_prefix = [] # -- 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 = "sphinx_rtd_theme" if use_rtd_theme else '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. html_theme_path = [sphinx_rtd_theme.get_html_theme_path() if use_rtd_theme else '_theme'] # 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 an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large.
napoleon_use_admonition_for_references = False napoleon_use_ivar = False napoleon_use_param = True napoleon_use_rtype = True # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. on_rtd = os.environ.get('READTHEDOCS', None) == 'True' if not on_rtd: # only import and set the theme if we're building docs locally import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' # Add any paths that contain custom themes here, relative to this # directory. html_theme_path = ['_themes'] + [sphinx_rtd_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 = "phi.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. # html_theme_options = {} html_sidebars = {'**': ['localtoc.html']} # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". html_title = version + " documentation"
# The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'sphinx_rtd_theme' html_theme_path = ['_themes'] # 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". import sphinx_rtd_theme html_static_path = [join(sphinx_rtd_theme.get_html_theme_path(), 'sphinx_rtd_theme', 'static')] # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # The default sidebars (for documents that don't match any pattern) are # defined by theme itself. Builtin themes are using these templates by # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. # # html_sidebars = {} # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder.
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 = 'sphinx_rtd_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 # documentation. # html_theme_options = {'collapse_navigation': False, 'display_version': True} html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # 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 ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'rayvision_apidoc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper').
intersphinx_mapping = { # 'pyglet': ('http://pyglet.readthedocs.io/en/latest', None), } # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False ## Options for HTML output # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. from sphinx_rtd_theme import get_html_theme_path html_theme = "sphinx_rtd_theme" html_theme_path = [get_html_theme_path()] html_favicon = 'favicon.ico' # 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
# keep_warnings = False # -- 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 = "sphinx_rtd_theme" if rtd_theme_available else "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. html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] if rtd_theme_available else [] # 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 an image file (relative to this directory) to place at the top # of the sidebar. # html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large.
# -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. html_theme = "sphinx_rtd_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 # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. import sphinx_rtd_theme html_theme_path = [sphinx_rtd_theme.get_html_theme_path(),os.path.abspath('./_themes')] # 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 an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large.
modindex_common_prefix = [] # -- 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' if on_rtd else 'sphinx_rtd_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 # documentation. html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. html_theme_path = [] if on_rtd else [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". html_title = 'rebase-helper {0} documentation'.format(VERSION) # A shorter title for the navigation bar. Default is the same as html_title. html_short_title = html_title # The name of an image file (relative to this directory) to place at the top # of the sidebar. html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large.
# A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- 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' on_rtd = os.environ.get('READTHEDOCS', None) == 'True' if not on_rtd: # only import and set the theme if we're building docs locally import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_theme_path = ["_themes", sphinx_rtd_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 = {} # Add any paths that contain custom themes here, relative to this directory. #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
pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- 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_rtd_theme as rtd html_theme = "sphinx_rtd_theme" html_theme_path = [rtd.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 = {} # Add any paths that contain custom themes here, relative to this directory. #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 Theme MUST BE AN OPEN SOURCE SPHINX THEME. Contributors outside of # Adfinis SyGroup AG must be able to build the documentation. # Developers of Adfinis SyGroup AG can build the documentation using # make html_adsy # .. or .. # make SPHINXOPTS="-D html_theme='adsy'" html html_theme = 'adsy' # 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. html_theme_path = [ 'adsy-sphinx-template.src/html', sphinx_rtd_theme.get_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 an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None
html_static_path = [] if os.path.exists('_static'): html_static_path.append('_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = False if 'html_theme' in globals(): if html_theme in ['default']: # Allow people to bail with a hack of having an html_style if not 'html_style' in globals(): import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(sphinx_rtd_theme.get_html_theme_path()) else: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] using_rtd_theme = True else: import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(sphinx_rtd_theme.get_html_theme_path()) else: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] using_rtd_theme = True
# A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. #keep_warnings = False # -- 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' import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] print "Loading RTD Theme from {}".format(sphinx_rtd_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 = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". #html_title = None
# This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys import os try: import sphinx_rtd_theme HTML_THEME = "sphinx_rtd_theme" HTML_THEME_PATH = [sphinx_rtd_theme.get_html_theme_path()] except ImportError: HTML_THEME = 'default' HTML_THEME_PATH = [] # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0'
def html_theme_path(self): if os.environ.get('READTHEDOCS', False): return [] import sphinx_rtd_theme return [sphinx_rtd_theme.get_html_theme_path()]
#modindex_common_prefix = [] # -- 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 = 'sphinx_rtd_theme' if sphinx_rtd_theme else '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. html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] if sphinx_rtd_theme else [] # 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 an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large.
# If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- import sphinx_rtd_theme html_theme = 'julia' html_theme_path = ['_theme',sphinx_rtd_theme.get_html_theme_path()] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. #html_theme = 'scipy' # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = ['_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 # documentation. #html_theme_options = { # "edit_link": False, # "rootlinks": [], # "sidebar": "right",
# If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # 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.todo', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates', sphinx_rtd_theme.get_html_theme_path()] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] source_suffix = ['.rst','.md'] source_parsers = { '.md': CommonMarkParser, } # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index'
# -- 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 = 'alabaster' html_theme = "sphinx_rtd_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 # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. html_theme_path = [ sphinx_rtd_theme.get_html_theme_path() ] print(sphinx_rtd_theme.get_html_theme_path()) # The name for this set of Sphinx documents. # "<project> v<release> documentation" by default. #html_title = 'The PoC-Library v1.0.0' # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None
# texinfo_no_detailmenu = False # Add style overrides def setup(app): app.add_stylesheet('styles/custom.css') # autoapi configuration autoapi_modules = { 'topology_lib_openssl': None } # Configure PlantUML plantuml = 'java -jar ' + join(dirname(abspath(__name__)), 'plantuml.8030.jar') plantuml_output_format = 'svg' # Configure Graphviz graphviz_output_format = 'svg' # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { 'python': ('https://docs.python.org/3.4', None) } # Setup theme if not building in readthedocs.org on_rtd = os.environ.get('READTHEDOCS', None) is not None if not on_rtd: import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'python': ('https://docs.python.org/2.7', None)} # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. on_rtd = os.environ.get('READTHEDOCS', None) == 'True' if on_rtd: html_theme = 'default' else: # only import and set the theme if we're building docs locally import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_theme_path = ['_themes', sphinx_rtd_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 = {} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # TEMP: see https://github.com/rtfd/readthedocs.org/issues/1692 # Add RTD Theme Path. #if 'html_theme_path' in globals(): # html_theme_path.append('/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx') #else: # html_theme_path = ['_themes', '/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx']