How to use alabaster - 10 common examples

pygments_style = 'sphinx'
exclude_patterns = []

# Sphinx Extensions
extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.autoprogram']

numpydoc_show_class_members = False

extlinks = {
    'issue': ('https://github.com/jcrist/hadoop-test-cluster/issues/%s', 'Issue #'),
    'pr': ('https://github.com/jcrist/hadoop-test-cluster/pull/%s', 'PR #')
}

# Sphinx Theme
html_theme = 'alabaster'
html_theme_path = [alabaster.get_path()]
templates_path = ['_templates']
html_static_path = ['_static']
html_theme_options = {
    'description': 'A docker setup for testing software on realistic Hadoop Clusters',
    'github_button': True,
    'github_count': False,
    'github_user': 'jcrist',
    'github_repo': 'hadoop-test-cluster',
    'travis_button': False,
    'show_powered_by': False,
    'page_width': '960px',
    'sidebar_width': '250px',
    'code_font_size': '0.8em'
}
html_sidebars = {
    '**': ['about.html',

def test_theme_api(app, status, warning):
    cfg = app.config

    themes = ['basic', 'default', 'scrolls', 'agogo', 'sphinxdoc', 'haiku',
              'traditional', 'epub', 'nature', 'pyramid', 'bizstyle', 'classic', 'nonav',
              'test-theme', 'ziptheme', 'staticfiles', 'parent', 'child']
    if alabaster.version.__version_info__ >= (0, 7, 11):
        themes.append('alabaster')

    # test Theme class API
    assert set(app.html_themes.keys()) == set(themes)
    assert app.html_themes['test-theme'] == app.srcdir / 'test_theme' / 'test-theme'
    assert app.html_themes['ziptheme'] == app.srcdir / 'ziptheme.zip'
    assert app.html_themes['staticfiles'] == app.srcdir / 'test_theme' / 'staticfiles'

    # test Theme instance API
    theme = app.builder.theme
    assert theme.name == 'ziptheme'
    themedir = theme.themedir
    assert theme.base.name == 'basic'
    assert len(theme.get_theme_dirs()) == 2

    # direct setting

# 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.
extensions += ['alabaster']
html_theme_options = {
    'github_user': 'ciscocloud',
    'github_repo': 'microservices-infrastructure',
    'logo': 'cisco.png',
    'logo_name': True,
}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [alabaster.get_path()]

# The name for this set of Sphinx documents.  If None, it defaults to
# " v 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.
#html_favicon = None

# 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 = 'alabaster'

import alabaster

html_theme_path = [alabaster.get_path()]
extensions += ['alabaster']
html_theme = 'alabaster'
html_sidebars = {
    '**': [
        'about.html',
        'navigation.html',
        'relations.html',
        'searchbox.html',
        'donate.html',
    ]
}
html_theme_options = {
    'github_user': 'derek73',
    'github_repo': 'python-nameparser',
    'travis_button': True,
    'analytics_id': 'UA-339019-11',

import os, sys
import alabaster

needs_sphinx = '1.4.3'

html_theme_path = [alabaster.get_path()]

sys.path.insert(0, os.path.abspath('../xpandas'))

extensions = ['alabaster', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
              'sphinx.ext.autosummary', 'sphinx.ext.viewcode', 'sphinx.ext.coverage',
              'sphinx.ext.doctest', 'sphinx.ext.ifconfig', 'sphinx.ext.pngmath',
              'sphinx.ext.napoleon', 'nbsphinx', 'IPython.sphinxext.ipython_console_highlighting',
              'sphinx.ext.autosectionlabel']

templates_path = ['_templates']

source_suffix = '.rst'

master_doc = 'index'

project = u'XPandas'

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

# Do not warn/fail about referencing remote images
suppress_warnings = ["image.nonlocal_uri"]

# -- Options for HTML output ----------------------------------------------

import alabaster

html_theme_path = [alabaster.get_path()]
extensions.append("alabaster")
html_theme = "alabaster"
html_sidebars = {
    "**": [
        # 'about.html',
        "navigation.html",
        # 'searchbox.html',
        # 'donate.html',
    ]
}

html_theme_options = {
    # 'logo': 'dials_icon.png',
    "github_button": False,
    "show_powered_by": False,
    "description": "Diffraction Integration for Advanced Light Sources",

#
# 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
import alabaster

html_theme = "alabaster"

html_theme_path = [alabaster.get_path()]
html_sidebars = {
    '**': [
        'about.html', 'navigation.html', 'searchbox.html'
    ]
}

html_theme_options = {
    'logo': 'prkng.png',
}

# 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 ------------------------------------------------

project = "Baseplate.py"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ["docs/html"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "friendly"

# -- Options for HTML output ----------------------------------------------

html_theme_path = [alabaster.get_path()]
html_static_path = ["images"]

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = "alabaster"

# The name for this set of Sphinx documents.  If None, it defaults to
# " v documentation".
# html_title =

# which templates to put in the sidebar.  we're just removing the relations
# section from the defaults here, that's "next article" and "previous article"
html_sidebars = {
    "**": ["about.html", "searchbox.html", "navigation.html"]
}

# -- 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 = [alabaster.get_path()]

# The name for this set of Sphinx documents.  If None, it defaults to
# " v 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.
html_favicon = "_static/favicon.ico"

'relations.html',
        'searchbox.html',
        'donate.html',
        'relations.html',
        'last_modified.html'
    ]
}

html_show_sourcelink = True


# Add any paths that contain custom themes here, relative to this directory.

if not on_rtd:  # only set the theme if we're building docs locally
    html_theme = 'alabaster'
    html_theme_path = [alabaster.get_path()]

else:
    from mock import Mock as MagicMock
    import sys

    class Mock(MagicMock):
        @classmethod
        def __getattr__(cls, name):
            return Mock()

    # include the names of your minimal required packages here
    MOCK_MODULES = ['h5py']
    sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

html_use_smartypants = True
html_last_updated_fmt = '%b %d, %Y'