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_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
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'mytheme'
# 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 = {'collapsiblesidebar': True}
html_theme_options = {
'github_user': '******',
'github_repo': 'uob-2015-efc',
'github_banner': True
}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['helpers', alabaster.get_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = "UoB 2015 EFC auxiliary exercises"
# A shorter title for the navigation bar. Default is the same as html_title.
html_short_title = "List of extra exercises"
# 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.
#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 = '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 themes here, relative to this directory.
html_theme_path = ["/usr/local/lib/python2.7/dist-packages",alabaster.get_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.
}
extlinks = {
'phpdoc': ('https://php.net/%s', ''),
'drupalapi': ('https://api.drupal.org/%s', ''),
'drupalnode': ('https://drupal.org/node/%s', None),
}
# -- Options for HTML output ----------------------------------------------
html_theme_path = ['_theme']
try:
import alabaster
html_theme_path.append(alabaster.get_path())
extensions.append('alabaster')
html_theme = 'book'
html_sidebars = {
'**': [
'about.html', 'navigation.html', 'searchbox.html',
]
}
html_theme_options = {
'github_user': '******',
'github_repo': 'drupal-security',
'show_powered_by': False,
}
except ImportError:
html_theme = 'default'
html_sidebars = {}
# 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 ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
import alabaster
table_styling_embed_css = False
html_theme_path = [alabaster.get_path(), "../themes"]
extensions += ['alabaster']
html_theme = 'cvxpy_alabaster'
html_sidebars = {
'**': [
'about.html', 'navigation.html', 'searchbox.html',
]
}
# 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 = {
'github_user': '******',
'github_repo': 'cvxpy',
'github_banner': True,
def load_alabaster_theme(self):
# type: () -> None
"""Load alabaster theme."""
import alabaster
self.themes['alabaster'] = path.join(alabaster.get_path(), 'alabaster')
# -- 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'
#html_theme = 'flask'
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 = {'touch_icon': 'touch-icon.png'}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['_themes', alabaster.get_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 = "favicon.png"
# 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.
import alabaster print(alabaster.get_path())
# -- 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'
#html_theme = 'flask'
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 = {'touch_icon': 'touch-icon.png'}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['_themes', alabaster.get_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 = "favicon.png"
# 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.
}
extlinks = {
'phpdoc': ('https://php.net/%s', ''),
'drupalapi': ('https://api.drupal.org/%s', ''),
'drupalnode': ('https://drupal.org/node/%s', None),
}
# -- Options for HTML output ----------------------------------------------
html_theme_path = ['_theme']
try:
import alabaster
html_theme_path.append(alabaster.get_path())
extensions.append('alabaster')
html_theme = 'book'
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'searchbox.html',
]
}
html_theme_options = {
'github_user': '******',
'github_repo': 'drupal-security',
'show_powered_by': False,
}
except ImportError:
sys.path.insert(0, os.path.abspath(os.path.join(os.path.split(__file__)[0])))
from pyquickhelper.helpgen.default_conf import set_sphinx_variables
def callback_begin():
print("[sphinx.conf.py] documentation started.")
set_sphinx_variables(
__file__,
"pyquickhelper",
"Xavier Dupré",
2022,
"alabaster",
alabaster.get_path(),
locals(),
github_repo="https://github.com/sdpython/pyquickhelper.git",
extlinks=dict(issue=('https://github.com/sdpython/pyquickhelper/issues/%s',
'issue ')),
link_resolve="http://www.xavierdupre.fr/app/",
callback_begin=callback_begin)
# there is an issue with this attribute on Anaconda math_number_all
assert math_number_all or not math_number_all
blog_root = "http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/"
# remove notebooks following this pattern
nbneg_pattern = ".*[\\\\/]temp_.*"
html_css_files = ['my-styles.css', 'gallery-dataframe.css']
# coding: utf-8
import sys
import os
import alabaster
from pyquickhelper.helpgen.default_conf import set_sphinx_variables
sys.path.insert(0, os.path.abspath(os.path.join(os.path.split(__file__)[0])))
set_sphinx_variables(__file__, "check_python_install", "Xavier Dupré", 2021,
"alabaster", alabaster.get_path(), locals(), add_extensions=['alabaster'],
extlinks=dict(issue=('https://github.com/sdpython/_check_python_install/issues/%s', 'issue')))
blog_root = "http://www.xavierdupre.fr/app/_check_python_install/helpsphinx/"
html_logo = "phdoc_static/project_ico.png"
notebooks_urls = "http://www.xavierdupre.fr/app/_check_python_install/helpsphinx/notebooks/"
nblinks = {
'slideshowrst': notebooks_urls + 'slide_show.html',
}
epkg_dictionary.update({
'cartopy': 'https://scitools.org.uk/cartopy/docs/latest/',
})
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
'logo': 'bb_logo_128x128.png',
'logo_name': True,
'description': 'A temperature management framework written in Python.',
'github_button': True,
'github_user': '******',
'github_repo': 'braubuddy',
'analytics_id': 'UA-1269813-4',
}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [
'_themes',
alabaster.get_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 = '../images/logo/bb_logo_128x128.png'
# 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
extlinks = {
'project': ('/projects/%s', ''),
'institute': ('http://cyborginstitute.com/%s', ''),
'issues': ('http://issues.cyborginstitute.com/%s', ''),
'list': ('http://lists.cyborginstitute.com/listinfo/%s', ''),
'git': ('http://git.cyborginstitute.com/%s', ''),
'github': ('http://github.com/cyborginstitute/%s', '')
}
# -- Options for HTML output ---------------------------------------------------
git_name = 'institute'
html_theme = sconf.theme.name
html_theme_path = [ os.path.join(conf.paths.output, 'institute-tools', 'themes'), alabaster.get_path() ]
html_static_path = ['.static']
html_use_smartypants = True
html_theme_options = {
'analytics_id': sconf.theme.google_analytics,
'github_user': '******',
'github_repo': 'administration',
'github_button': True,
}
html_sidebars = sconf.sidebars
html_title = sconf.theme.sitename
html_short_title = html_title
pygments_style = "sphinx"
extlinks = {}
## add `extlinks` for each published version.
for i in conf.git.branches.published:
extlinks[i] = ("".join([conf.project.url, "/", i, "%s"]), "")
intersphinx_mapping = {}
for i in conf.system.files.data.intersphinx:
intersphinx_mapping[i.name] = (i.url, os.path.join(conf.paths.projectroot, conf.paths.output, i.path))
# -- Options for HTML output ---------------------------------------------------
html_theme = sconf.theme.name
html_theme_path = [os.path.join(conf.paths.output, "institute-tools", "themes"), alabaster.get_path()]
html_title = conf.project.title
htmlhelp_basename = "rhizome"
html_logo = None
html_static_path = sconf.paths.static
html_copy_source = False
html_use_smartypants = True
html_domain_indices = True
html_use_index = True
html_split_index = False
html_show_sourcelink = False
html_show_sphinx = True
html_show_copyright = True
# -*- coding: utf-8 -*-
import alabaster as theme
import os
project = 'MNMLSTC Core'
copyright = 'MNMLSTC'
version = '1.2'
release = '1.2'
needs_sphinx = '1.3'
html_static_path = ['static']
html_theme_path = [theme.get_path()]
html_theme = 'alabaster'
html_theme_options = { 'show_powered_by' : False }
html_style = 'theme.css'
html_sidebars = { '**' : ['navigation.html'] }
highlight_language = 'cpp'
primary_domain = 'cpp'
pygments_style = 'manni'
exclude_patterns = ['_build']
templates_path = ['templates']
source_suffix = '.rst'
master_doc = 'index'
rst_prolog = '''
.. role:: cxx(code)
# 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.autodoc',
'sphinxcontrib.napoleon',
'sphinx.ext.viewcode',
'alabaster'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates', alabaster.get_path()]
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'MassWeb'
copyright = get_authors(u'2015, %s')
# The version info for the project you're documenting, acts as replacement for
# -- General configuration ------------------------------------------------
# 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.autodoc', 'sphinxcontrib.napoleon', 'sphinx.ext.viewcode',
'alabaster'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates', alabaster.get_path()]
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'MassWeb'
copyright = get_authors(u'2015, %s')
# The version info for the project you're documenting, acts as replacement for
def load_alabaster_theme(self) -> None:
"""Load alabaster theme."""
import alabaster
self.themes['alabaster'] = path.join(alabaster.get_path(), 'alabaster')
# 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 ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
import alabaster
table_styling_embed_css = False
html_theme_path = [alabaster.get_path(), "../themes"]
extensions += ['alabaster']
html_theme = 'cvxpy_alabaster'
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'searchbox.html',
]
}
# 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 = {
'github_user': '******',
# -*- coding: utf-8 -*-
import sys
import os
import alabaster
from pyquickhelper.helpgen.default_conf import set_sphinx_variables
sys.path.insert(0, os.path.abspath(os.path.join(os.path.split(__file__)[0])))
set_sphinx_variables(__file__, "pysqllike", "Xavier Dupré", 2019,
"alabaster", alabaster.get_path(), locals(), add_extensions=['alabaster'],
extlinks=dict(issue=('https://github.com/sdpython/pysqllike/issues/%s', 'issue')))
blog_root = "http://www.xavierdupre.fr/app/sqllike/helpsphinx/"
# blog_feed_titles = False
# blog_archive_titles = False
# post_auto_excerpt = 1
# THEME
html_style = 'alabaster.css'
html_theme = 'alabaster'
html_sidebars = {
'**': [
'custom_about.html', 'postcard.html', 'recentposts.html',
'tagcloud.html', 'categories.html', 'archives.html', 'searchbox.html'
]
}
html_theme_path = [alabaster.get_path()]
html_theme_options = {
'travis_button': False,
'github_user': '******',
'github_repo': 'pygears',
'description': 'HW Design: A Functional Approach',
'logo': 'logo.png',
'sidebar_width': '230px'
}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'PyGearsdoc'
# -- Options for LaTeX output ------------------------------------------------
from datetime import datetime
import os
import sys
import alabaster
# Alabaster theme + mini-extension
html_theme_path = [alabaster.get_path()]
extensions = ['alabaster']
# Paths relative to invoking conf.py - not this shared file
html_static_path = ['../_shared_static']
html_theme = 'alabaster'
html_theme_options = {
'description': "A Python implementation of SSHv2.",
'github_user': '******',
'github_repo': 'paramiko',
'gittip_user': '******',
'analytics_id': 'UA-18486793-2',
'link': '#3782BE',
'link_hover': '#3782BE',
}
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'searchbox.html',
'donate.html',
]
}
# -*- coding: utf-8 -*-
import sys
import os
import alabaster
from pyquickhelper.helpgen.default_conf import set_sphinx_variables
sys.path.insert(0, os.path.abspath(os.path.join(os.path.split(__file__)[0])))
local_template = os.path.join(os.path.abspath(
os.path.dirname(__file__)), "phdoc_templates")
set_sphinx_variables(__file__, "wrapclib", "Xavier Dupré", 2022,
"alabaster", alabaster.get_path(),
locals(), extlinks=dict(
issue=('https://github.com/sdpython/wrapclib/issues/%s', 'issue')),
title="wrapclib", book=True)
blog_root = "http://www.xavierdupre.fr/app/wrapclib/helpsphinx/"
html_css_files = ['my-styles.css']
html_logo = "phdoc_static/project_ico.png"
html_sidebars = {}
language = "en"
epkg_dictionary.update({
'C': 'https://en.wikipedia.org/wiki/C_(programming_language)',
'C++': 'https://en.wikipedia.org/wiki/C%2B%2B',
're2': 'https://github.com/google/re2',
'pyre2': 'https://github.com/facebook/pyre2',
})
