Exemplo n.º 1
0
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.
#
# html_theme = 'alabaster'

html_theme = "flask"
html_theme_options = {"index_sidebar_logo": True}
html_context = {
    "project_links": [
        ProjectLink(
            "Source Code",
            "https://github.com/CornellDataScience/audio-deidentification",
        ),
        ProjectLink("CDS Team", "https://cornelldata.science"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}

# 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"]
Exemplo n.º 2
0
    "click": ("https://click.palletsprojects.com/", None),
    "jinja": ("https://jinja.palletsprojects.com/", None),
    "itsdangerous": ("https://itsdangerous.palletsprojects.com/", None),
    "sqlalchemy": ("https://docs.sqlalchemy.org/", None),
    "wtforms": ("https://wtforms.readthedocs.io/", None),
    "blinker": ("https://pythonhosted.org/blinker/", None),
}
issues_github_path = "pallets/flask"

# HTML -----------------------------------------------------------------

html_theme = "flask"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("捐赠", "https://palletsprojects.com/donate"),
        ProjectLink("PyPI Releases", "https://pypi.org/project/Flask/"),
        ProjectLink("源码", "https://github.com/pallets/flask/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/pallets/flask/issues/"),
        ProjectLink("网站", "https://palletsprojects.com/p/flask/"),
        ProjectLink("Twitter", "https://twitter.com/PalletsTeam"),
        ProjectLink("聊天", "https://discord.gg/pallets"),
        ProjectLink("参与翻译", "https://github.com/greyli/flask-docs-zh"),
    ]
}
html_sidebars = {
    "index":
    ["project.html", "localtoc.html", "searchbox.html", "ethicalads.html"],
    "**":
    ["localtoc.html", "relations.html", "searchbox.html", "ethicalads.html"],
Exemplo n.º 3
0
# 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 = "flask"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("Flask Website", "https://palletsprojects.com/p/flask/"),
        ProjectLink("PyPI releases",
                    "https://pypi.org/project/Flask-GoogleStorage/"),
        ProjectLink("Source Code",
                    "https://github.com/svidela/flask-googlestorage/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/svidela/flask-googlestorage/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
html_title = f"Flask-GoogleStorage Documentation ({version})"
html_show_sourcelink = False
Exemplo n.º 4
0
    "sphinxcontrib.log_cabinet",
    "sphinx_issues",
]
intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
    "alembic": ("https://alembic.sqlalchemy.org/en/latest/", None),
    "flask_script": ("https://flask-script.readthedocs.io/en/latest/", None),
}
issues_github_path = "davidism/flask-alembic"

# HTML -----------------------------------------------------------------

html_theme = "flask"
html_context = {
    "project_links": [
        ProjectLink("Donate to Flask",
                    "https://www.palletsprojects.com/donate"),
        ProjectLink("PyPI Releases",
                    "https://pypi.org/project/Flask-Alembic/"),
        ProjectLink("Source Code",
                    "https://github.com/davidism/flask-alembic"),
        ProjectLink("Issue Tracker",
                    "https://github.com/davidism/flask-alembic/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_title = f"{project} Documentation ({version})"
html_show_sourcelink = False
Exemplo n.º 5
0
# HTML -----------------------------------------------------------------

sys.path.append(os.path.abspath('_themes'))
sys.path.insert(0, os.path.abspath("../utils/"))
html_theme_path = ['_themes']
html_theme = "searx"

# sphinx.ext.imgmath setup
html_math_renderer = 'imgmath'
imgmath_image_format = 'svg'
imgmath_font_size = 14
# sphinx.ext.imgmath setup END

html_theme_options = {"index_sidebar_logo": True}
html_context = {"project_links": []}
html_context["project_links"].append(ProjectLink("Blog", "blog/index.html"))
if brand.GIT_URL:
    html_context["project_links"].append(ProjectLink("Source", brand.GIT_URL))
if brand.WIKI_URL:
    html_context["project_links"].append(ProjectLink("Wiki", brand.WIKI_URL))
if brand.PUBLIC_INSTANCES:
    html_context["project_links"].append(
        ProjectLink("Public instances", brand.PUBLIC_INSTANCES))
if brand.TWITTER_URL:
    html_context["project_links"].append(
        ProjectLink("Twitter", brand.TWITTER_URL))
if brand.ISSUE_URL:
    html_context["project_links"].append(
        ProjectLink("Issue Tracker", brand.ISSUE_URL))
if brand.CONTACT_URL:
    html_context["project_links"].append(
Exemplo n.º 6
0
# 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', 'README.md']

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

# HTML -----------------------------------------------------------------

html_theme = 'click'
html_theme_options = {'index_sidebar_logo': False}
html_context = {
    'project_links': [
        ProjectLink('Quickstart', 'quickstart.html'),
        ProjectLink('Documentation TOC', 'index.html#documentation'),
        ProjectLink('API Reference TOC', 'index.html#api-reference'),
        ProjectLink('Project Website', 'https://rastervision.io/'),
        ProjectLink('PyPI releases', 'https://pypi.org/project/rastervision/'),
        ProjectLink('GitHub', 'https://github.com/azavea/raster-vision'),
        ProjectLink('Gitter Channel',
                    'https://gitter.im/azavea/raster-vision'),
        ProjectLink('Raster Vision Examples',
                    'https://github.com/azavea/raster-vision-examples'),
        ProjectLink('AWS Batch Setup',
                    'https://github.com/azavea/raster-vision-aws'),
        ProjectLink('Issue Tracker',
                    'https://github.com/azavea/raster-vision/issues/'),
        ProjectLink('CHANGELOG', 'changelog.html'),
        ProjectLink('Azavea', 'https://www.azavea.com/'),
Exemplo n.º 7
0
    "werkzeug": ("http://werkzeug.pocoo.org/docs/", None),
    "click": ("https://click.palletsprojects.com/", None),
    "jinja": ("http://jinja.pocoo.org/docs/", None),
    "itsdangerous": ("https://itsdangerous.palletsprojects.com/", None),
    "sqlalchemy": ("https://docs.sqlalchemy.org/", None),
    "wtforms": ("https://wtforms.readthedocs.io/en/stable/", None),
    "blinker": ("https://pythonhosted.org/blinker/", None),
}

# HTML -----------------------------------------------------------------

html_theme = "flask"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("Donate to Pallets", "https://palletsprojects.com/donate"),
        ProjectLink("Flask Website", "https://palletsprojects.com/p/flask/"),
        ProjectLink("PyPI releases", "https://pypi.org/project/Flask/"),
        ProjectLink("Source Code", "https://github.com/pallets/flask/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/pallets/flask/issues/"),
    ]
}
html_sidebars = {
    "index":
    ["project.html", "localtoc.html", "versions.html", "searchbox.html"],
    "**":
    ["localtoc.html", "relations.html", "versions.html", "searchbox.html"],
}
singlehtml_sidebars = {
    "index": ["project.html", "versions.html", "localtoc.html"]
Exemplo n.º 8
0
author = "Pallets Team"
release, version = get_version("itsdangerous")

# General --------------------------------------------------------------

master_doc = "index"
extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "pallets_sphinx_themes"]
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}

# HTML -----------------------------------------------------------------

html_theme = "flask"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("Pallets에 후원하기", "https://palletsprojects.com/donate"),
        ProjectLink("웹사이트", "https://palletsprojects.com/p/itsdangerous/"),
        ProjectLink("PyPI 릴리스", "https://pypi.org/project/itsdangerous/"),
        ProjectLink("소스 코드", "https://github.com/pallets/itsdangerous/"),
        ProjectLink("이슈 트래커", "https://github.com/pallets/itsdangerous/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_static_path = ["_static"]
html_logo = "_static/itsdangerous-logo-sidebar.png"
html_title = "itsdangerous Documentation ({})".format(version)
html_show_sourcelink = False
Exemplo n.º 9
0
# 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 = "sphinx_rtd_theme"

html_context = {
    "project_links": [
        ProjectLink("Source Code", "https://github.com/WDscholia/scholia"),
        ProjectLink("Issue Tracker",
                    "https://github.com/WDscholia/scholia/issues"),
        ProjectLink("Website", "https://scholia.toolforge.org/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}

html_static_path = ["_static"]
html_favicon = "_static/favicon.ico"
html_logo = "_static/mstile-310.png"
html_title = f"Scholia Documentation"
Exemplo n.º 10
0
# -- 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 = 'click'

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

html_theme_options = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("Source Code", "https://github.com/datadavev/sotools/"),
        ProjectLink("Issue Tracker", "https://github.com/datadavev/sotools/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_title = f"SOtools Documentation ({version})"
html_show_sourcelink = False

html_css_files = [
    "css/custom.css",
]
Exemplo n.º 11
0
    "_templates",
]

exclude_patterns = [
    "_build",
    "Thumbs.db",
    ".DS_Store",
    ".git",
    "venv",
]

html_theme = "flask"

html_context = {
    "project_links": [
        ProjectLink("Source Code", "https://github.com/questionlp/wwdtm"),
        ProjectLink("Stats API", "https://api.wwdt.me/"),
        ProjectLink("Stats Page", "https://stats.wwdt.me/"),
        ProjectLink("Graphs Site", "https://graphs.wwdt.me/"),
        ProjectLink("Reports Site", "https://reports.wwdt.me/"),
    ]
}

html_sidebars = {
    "index": [
        "globaltoc.html",
        "project.html",
        "searchbox.html",
    ],
    "**": [
        "globaltoc.html",
Exemplo n.º 12
0
intersphinx_mapping = {
    'python': ('https://docs.python.org/3/', None),
    'werkzeug': ('http://werkzeug.pocoo.org/docs/', None),
    'click': ('http://click.pocoo.org/', None),
    'jinja': ('http://jinja.pocoo.org/docs/', None),
    'itsdangerous': ('https://pythonhosted.org/itsdangerous', None),
    'sqlalchemy': ('https://docs.sqlalchemy.org/en/latest/', None),
}

# HTML -----------------------------------------------------------------

html_theme = "flask"
html_theme_options = {"index_sidebar_logo": True}
html_context = {
    "project_links": [
        ProjectLink("Choppy Website", "http://docs.3steps.cn"),
        ProjectLink("Choppy App Store", "http://choppy.3steps.cn"),
        ProjectLink("Source Code", "https://github.com/go-choppy/choppy"),
        ProjectLink("Issue Tracker",
                    "https://github.com/go-choppy/choppy/issues"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "versions.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "versions.html", "searchbox.html"],
}
singlehtml_sidebars = {
    "index": ["project.html", "versions.html", "localtoc.html"]}
html_static_path = ["_static"]
html_favicon = "_static/choppy-icon.png"
html_logo = "_static/choppy-logo-sidebar.png"
Exemplo n.º 13
0
# 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.
#
extensions += ['pallets_sphinx_themes']
html_theme = 'flask'
html_theme_options = {"index_sidebar_logo": False}

from pallets_sphinx_themes import ProjectLink
html_context = {
    "project_links": [
        ProjectLink("NEST Homepage",
                    "http://cse-apps2.case.edu/panli/doku.php?id=nest"),
        # ProjectLink("Source Code", "https://github.com/Mestrace/secure-outsourcing")
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}

html_static_path = ["_static"]
html_favicon = "_static/secout_icon.png"
html_logo = "_static/secout_icon.png"
html_title = "Secout Documentation"
html_show_sourcelink = False
Exemplo n.º 14
0
    'sphinx.ext.intersphinx',
    'sphinx.ext.viewcode',
    'sphinx_issues',
    'sphinxcontrib.autohttp.flask',
]
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
issues_github_path = 'TheEdgeOfRage/deploy-webhook'
exclude_patterns = ['_build']
source_suffix = '.rst'

# HTML -----------------------------------------------------------------

html_theme = "werkzeug"
html_context = {
    "project_links": [
        ProjectLink("Source Code",
                    "https://github.com/TheEdgeOfRage/deploy-webhook/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/TheEdgeOfRage/deploy-webhook/issues/"),
        ProjectLink("Docker Hub",
                    "https://hub.docker.com/r/theedgeofrage/deploy-webhook"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_title = "Deploy-Webhook documentation"
html_show_sourcelink = False

Exemplo n.º 15
0
# 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 = []

default_role = 'any'

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

html_context = {
    'project_links': [
        ProjectLink('Source Code', 'https://github.com/FFY00/python-build/'),
        ProjectLink('Issue Tracker',
                    'https://github.com/FFY00/python-build/issues/'),
    ]
}
html_sidebars = {
    'index': ['project.html', 'localtoc.html', 'searchbox.html'],
}

# 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']
Exemplo n.º 16
0
nitpicky = True
nitpick_ignore = [("py:attr", "LoginManager.unauthorized"), ("py:class", "function")]

# -- 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 = "flask"

# 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 = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("PyPI releases", "https://pypi.org/project/Flask-Security-Too/"),
        ProjectLink("Source Code", "https://github.com/jwag956/flask-security/"),
        ProjectLink(
            "Issue Tracker", "https://github.com/jwag956/flask-security/issues/"
        ),
    ]
}

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
# html_title = "Flask-Security Documentation ({}).format(version)"
html_logo = "_static/logo-owl-105.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.
Exemplo n.º 17
0
# General --------------------------------------------------------------

master_doc = "index"
extensions = [
    "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "pallets_sphinx_themes"
]
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}

# HTML -----------------------------------------------------------------

html_theme = "flask"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("Donate to Pallets", "https://palletsprojects.com/donate"),
        ProjectLink("Website", "https://palletsprojects.com/p/itsdangerous/"),
        ProjectLink("PyPI releases", "https://pypi.org/project/ItsDangerous/"),
        ProjectLink("Source Code", "https://github.com/pallets/itsdangerous/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/pallets/itsdangerous/issues/"),
    ]
}
html_sidebars = {"index": ["project.html", "localtoc.html", "versions.html"]}
html_static_path = ["_static"]
html_title = "It's Dangerous Documentation ({})".format(version)
html_show_sourcelink = False
html_domain_indices = False
html_experimental_html5_writer = True

# LaTeX ----------------------------------------------------------------
Exemplo n.º 18
0
    "sphinx.ext.viewcode",
    "pallets_sphinx_themes",
    "sphinx_issues",
    "sphinxcontrib.log_cabinet",
]
intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
}
issues_github_path = "ennkua/e-wtforms"

# HTML -----------------------------------------------------------------

html_theme = "werkzeug"
html_context = {
    "project_links": [
        ProjectLink("PyPI Releases", "https://pypi.org/project/e-WTForms/"),
        ProjectLink("Source Code", "https://github.com/ennkua/e-wtforms/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/ennkua/e-wtforms/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_static_path = ["_static"]
html_logo = "_static/e-wtforms.png"
html_title = f"e-WTForms Documentation ({version})"
html_show_sourcelink = False
Exemplo n.º 19
0
# HTML -----------------------------------------------------------------

sys.path.append(os.path.abspath('_themes'))
html_theme_path = ['_themes']
html_theme = "searx"

# sphinx.ext.imgmath setup
html_math_renderer = 'imgmath'
imgmath_image_format = 'svg'
imgmath_font_size = 14
# sphinx.ext.imgmath setup END

html_theme_options = {"index_sidebar_logo": True}
html_context = {
    "project_links": [
        ProjectLink("Source", GIT_URL),
        ProjectLink("Wiki", "https://github.com/asciimoo/searx/wiki"),
        ProjectLink(
            "Public instances",
            "https://asciimoo.github.io/searx/user/public_instances.html"),
        ProjectLink("Twitter", "https://twitter.com/Searx_engine"),
    ]
}
html_sidebars = {
    "**": ["project.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_static_path = ["static"]
html_logo = "static/img/searx_logo_small.png"
html_title = "Searx Documentation ({})".format(
    "Searx-{}.tex".format(VERSION_STRING))
Exemplo n.º 20
0
    'werkzeug': ('http://werkzeug.pocoo.org/docs/', None),
    'click': ('http://click.pocoo.org/', None),
    'jinja': ('http://jinja.pocoo.org/docs/', None),
    'itsdangerous': ('https://pythonhosted.org/itsdangerous', None),
    'sqlalchemy': ('https://docs.sqlalchemy.org/en/latest/', None),
    'wtforms': ('https://wtforms.readthedocs.io/en/latest/', None),
    'blinker': ('https://pythonhosted.org/blinker/', None),
}

# HTML -----------------------------------------------------------------

html_theme = 'flask'
html_context = {
    'project_links': [
        ProjectLink(
            'Donate to Pallets',
            'https://psfmember.org/civicrm/contribute/transact?reset=1&id=20'),
        ProjectLink('Flask Website', 'https://palletsprojects.com/p/flask/'),
        ProjectLink('PyPI releases', 'https://pypi.org/project/Flask/'),
        ProjectLink('Source Code', 'https://github.com/pallets/flask/'),
        ProjectLink('Issue Tracker',
                    'https://github.com/pallets/flask/issues/'),
    ],
    'versions': [
        DocVersion('dev', 'Development', 'unstable'),
        DocVersion('1.0', 'Flask 1.0', 'stable'),
        DocVersion('0.12', 'Flask 0.12'),
    ],
    'canonical_url':
    'http://flask.pocoo.org/docs/{}/'.format(version),
    'carbon_ads_args':
Exemplo n.º 21
0
    "sphinxcontrib.log_cabinet",
    "sphinx_issues",
]

intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
}

issues_github_path = "pallets/secure-cookie"

# HTML -----------------------------------------------------------------

html_theme = "flask"
html_context = {
    "project_links": [
        ProjectLink("Donate to Pallets", "https://palletsprojects.com/donate"),
        ProjectLink("PyPI releases",
                    "https://pypi.org/project/secure-cookie/"),
        ProjectLink("Source Code",
                    "https://github.com/pallets/secure-cookie/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/pallets/secure-cookie/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_title = f"{project} Documentation ({version})"
html_show_sourcelink = False
Exemplo n.º 22
0
master_doc = "index"
extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.intersphinx",
    "pallets_sphinx_themes",
    "sphinx_issues",
]
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
issues_github_path = "pallets/werkzeug"

# HTML -----------------------------------------------------------------

html_theme = "werkzeug"
html_context = {
    "project_links": [
        ProjectLink("Donate to Pallets", "https://www.palletsprojects.com/donate"),
        ProjectLink("Werkzeug Website", "https://palletsprojects.com/p/werkzeug/"),
        ProjectLink("PyPI releases", "https://pypi.org/project/Werkzeug/"),
        ProjectLink("Source Code", "https://github.com/pallets/werkzeug/"),
        ProjectLink("Issue Tracker", "https://github.com/pallets/werkzeug/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_static_path = ["_static"]
html_favicon = "_static/favicon.ico"
html_logo = "_static/werkzeug.png"
html_title = "Werkzeug Documentation ({})".format(version)
Exemplo n.º 23
0
    # "jinja": ("https://jinja.palletsprojects.com/", None),
}

issues_github_path = "asciimoo/searx"

# HTML -----------------------------------------------------------------

sys.path.append(os.path.abspath('_themes'))

html_theme_path = ['_themes']
html_theme = "searx"

html_theme_options = {"index_sidebar_logo": True}
html_context = {
    "project_links": [
        ProjectLink("Source", GIT_URL),
        ProjectLink("Wiki", "https://github.com/asciimoo/searx/wiki"),
        ProjectLink("Public instances", "https://github.com/asciimoo/searx/wiki/Searx-instances"),
        ProjectLink("Twitter", "https://twitter.com/Searx_engine"),
    ]
}
html_sidebars = {
    "**": ["project.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_static_path = ["static"]
html_logo = "static/img/searx_logo_small.png"
html_title = "Searx Documentation ({})".format("Searx-{}.tex".format(VERSION_STRING))
html_show_sourcelink = False

# LaTeX ----------------------------------------------------------------
Exemplo n.º 24
0
    "pallets_sphinx_themes",
    "sphinxcontrib.log_cabinet",
    "sphinx_issues",
]
autoclass_content = "both"
autodoc_typehints = "description"
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
issues_github_path = "pallets/itsdangerous"

# HTML -----------------------------------------------------------------

html_theme = "flask"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("Donate", "https://palletsprojects.com/donate"),
        ProjectLink("PyPI Releases", "https://pypi.org/project/itsdangerous/"),
        ProjectLink("Source Code", "https://github.com/pallets/itsdangerous/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/pallets/itsdangerous/issues/"),
        ProjectLink("Website", "https://palletsprojects.com/p/itsdangerous/"),
        ProjectLink("Twitter", "https://twitter.com/PalletsTeam"),
        ProjectLink("Chat", "https://discord.gg/pallets"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_static_path = ["_static"]
Exemplo n.º 25
0
    "sphinx.ext.intersphinx",
    "sphinxcontrib.log_cabinet",
    "pallets_sphinx_themes",
    "sphinx_issues",
    "sphinx_tabs.tabs",
    "numpydoc",
]
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
issues_github_path = "kqf/ir-metrics"

# HTML
html_theme = "flask"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("Website", "https://ir-metrics.readthedocs.io"),
        ProjectLink("PyPI releases", "https://pypi.org/project/ir-metrics/"),
        ProjectLink("Source Code", "https://github.com/kqf/ir-metrics/"),
        ProjectLink("Issues", "https://github.com/kqf/ir-metrics/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
# html_static_path = ["_static"]
# html_favicon = "_static/ir-metrics-icon.png"
# html_logo = "_static/ir-metrics-logo-sidebar.png"
html_title = f"ir-metrics Documentation ({version})"
html_show_sourcelink = False
Exemplo n.º 26
0
    "pallets_sphinx_themes",
    "sphinx_issues",
]
intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
    "flask": ("https://flask.palletsprojects.com/", None),
    "sqlalchemy": ("https://docs.sqlalchemy.org/en/latest/", None),
}
issues_github_path = "pallets/flask-sqlalchemy"

# HTML -----------------------------------------------------------------

html_theme = "flask"
html_context = {
    "project_links": [
        ProjectLink("Donate", "https://palletsprojects.com/donate"),
        ProjectLink("PyPI Releases",
                    "https://pypi.org/project/Flask-SQLAlchemy/"),
        ProjectLink("Source Code",
                    "https://github.com/pallets/flask-sqlalchemy/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/pallets/flask-sqlalchemy/issues/"),
        ProjectLink("Website", "https://palletsprojects.com/"),
        ProjectLink("Twitter", "https://twitter.com/PalletsTeam"),
        ProjectLink("Chat", "https://discord.gg/pallets"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
Exemplo n.º 27
0
imgmath_image_format = 'svg'
imgmath_font_size = 14
# sphinx.ext.imgmath setup END

html_search_language = 'en'

sys.path.append(os.path.abspath('_themes'))
html_theme = "custom"
html_logo = 'darmarIT_logo_128.png'
html_theme_path = ['_themes']
# html_static_path     = ["static"]

html_theme_options = {"index_sidebar_logo": True}
html_context = {
    "project_links": [
        ProjectLink("Home", DOC_URL),
        ProjectLink("Source", GIT_URL),
        ProjectLink("API", DOC_URL + '/linuxdoc-api/linuxdoc.html'),
    ]
}
html_sidebars = {
    "**":
    ["project.html", "relations.html", "localtoc.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}

# ------------------------------------------------------------------------------
# Options of the kernel-doc parser
# ------------------------------------------------------------------------------

# If true, fatal errors (like missing function descripions) raise an error. If
Exemplo n.º 28
0
# General --------------------------------------------------------------

master_doc = "index"
extensions = [
    "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "pallets_sphinx_themes"
]
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}

# HTML -----------------------------------------------------------------

html_theme = "flask"
html_theme_options = {"index_sidebar_logo": False}
html_context = {
    "project_links": [
        ProjectLink("Donate to Pallets", "https://palletsprojects.com/donate"),
        ProjectLink("Website", "https://palletsprojects.com/p/markupsafe/"),
        ProjectLink("PyPI releases", "https://pypi.org/project/MarkupSafe/"),
        ProjectLink("Source Code", "https://github.com/pallets/markupsafe/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/pallets/markupsafe/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_title = "MarkupSafe Documentation ({})".format(version)
html_show_sourcelink = False
Exemplo n.º 29
0
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 = 'flask'
html_context = {
    "project_links": [
        ProjectLink("PyPI releases",
                    "https://pypi.org/project/Flask-Discussion/"),
        ProjectLink("Source Code",
                    "https://github.com/rmed/flask-discussion/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/rmed/flask-discussion/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_static_path = ["_static"]
html_title = "Flask-Discussion Documentation ({})".format(version)
html_show_sourcelink = False
Exemplo n.º 30
0
    "sphinx.ext.autodoc",
    "sphinx.ext.intersphinx",
    "pallets_sphinx_themes",
    "sphinx_issues",
    "sphinxcontrib.log_cabinet",
    "sphinx_markdown_builder",
]
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
# issues_github_path = ""

# HTML -----------------------------------------------------------------

html_theme = "werkzeug"
html_context = {
    "project_links": [
        ProjectLink("Doltpy Website", "https://dolthub.com"),
        ProjectLink("PyPI releases", "https://pypi.org/project/doltpy/"),
        ProjectLink("Source Code", "https://github.com/dolthub/doltpy/"),
        ProjectLink("Issue Tracker",
                    "https://github.com/dolthub/doltpy/issues/"),
    ]
}
html_sidebars = {
    "index": ["project.html", "localtoc.html", "searchbox.html"],
    "**": ["localtoc.html", "relations.html", "searchbox.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
# html_static_path = ["_static"]
# html_favicon = "_static/favicon.ico"
# html_logo = "_static/werkzeug.png"
html_title = f"Doltpy Documentation ({version})"