mirror of https://github.com/borgbackup/borg.git
docs: switch to a fresher theme
incidentally, fixes font size mismatches on firefox and chrome, at the same time. marvellous.
This commit is contained in:
parent
fa9940f0fe
commit
3fea2ac05e
|
@ -0,0 +1,10 @@
|
||||||
|
<div class="sidebar-block">
|
||||||
|
<div class="sidebar-toc">
|
||||||
|
{% set toctree = toctree(maxdepth=3, collapse=True, includehidden=True) %}
|
||||||
|
{% if toctree %}
|
||||||
|
{{ toctree }}
|
||||||
|
{% else %}
|
||||||
|
{{ toc }}
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
</div>
|
|
@ -0,0 +1,5 @@
|
||||||
|
<a href="{{ homepage() }}" class="text-logo">
|
||||||
|
<img src='{{ pathto('_static/logo.svg', 1) }}' width='100%'>
|
||||||
|
|
||||||
|
{{ theme_project_nav_name or shorttitle }}
|
||||||
|
</a>
|
|
@ -39,12 +39,45 @@ dt code {
|
||||||
font-weight: normal;
|
font-weight: normal;
|
||||||
}
|
}
|
||||||
|
|
||||||
.experimental,
|
/* bootstrap has a .container class which clashes with docutils' container class. */
|
||||||
|
.docutils.container {
|
||||||
|
width: auto;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* the default (38px) produces a jumpy baseline in Firefox on Linux. */
|
||||||
|
h1 {
|
||||||
|
font-size: 36px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.text-logo {
|
||||||
|
background-color: #000200;
|
||||||
|
color: #00dd00;
|
||||||
|
}
|
||||||
|
|
||||||
|
.text-logo:hover,
|
||||||
|
.text-logo:active,
|
||||||
|
.text-logo:focus {
|
||||||
|
color: #5afe57;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* by default the top and bottom margins are unequal which looks a bit unbalanced. */
|
||||||
|
.sidebar-block {
|
||||||
|
padding: 0;
|
||||||
|
margin: 14px 0 14px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#borg-documentation .external img {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.container.experimental,
|
||||||
#debugging-facilities,
|
#debugging-facilities,
|
||||||
#borg-recreate {
|
#borg-recreate {
|
||||||
/* don't change text dimensions */
|
/* don't change text dimensions */
|
||||||
margin: 0 -40px; /* padding below + border width */
|
margin: 0 -30px; /* padding below + border width */
|
||||||
padding: 0 20px; /* 20 px visual margin between edge of text and the border */
|
padding: 0 10px; /* 10 px visual margin between edge of text and the border */
|
||||||
/* fallback for browsers that don't have repeating-linear-gradient: thick, red lines */
|
/* fallback for browsers that don't have repeating-linear-gradient: thick, red lines */
|
||||||
border-left: 20px solid red;
|
border-left: 20px solid red;
|
||||||
border-right: 20px solid red;
|
border-right: 20px solid red;
|
||||||
|
@ -98,7 +131,6 @@ p .literal span {
|
||||||
cite {
|
cite {
|
||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
color: black; /* slight contrast with #404040 of regular text */
|
color: black; /* slight contrast with #404040 of regular text */
|
||||||
font-size: 75%;
|
|
||||||
font-family: Consolas, "Andale Mono WT", "Andale Mono", "Lucida Console", "Lucida Sans Typewriter",
|
font-family: Consolas, "Andale Mono WT", "Andale Mono", "Lucida Console", "Lucida Sans Typewriter",
|
||||||
"DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace;
|
"DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace;
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
|
|
45
docs/conf.py
45
docs/conf.py
|
@ -19,8 +19,6 @@ sys.path.insert(0, os.path.abspath('../src'))
|
||||||
|
|
||||||
from borg import __version__ as sw_version
|
from borg import __version__ as sw_version
|
||||||
|
|
||||||
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
|
||||||
|
|
||||||
# -- General configuration -----------------------------------------------------
|
# -- General configuration -----------------------------------------------------
|
||||||
|
|
||||||
# If your documentation needs a minimal Sphinx version, state it here.
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
|
@ -51,7 +49,8 @@ copyright = '2010-2014 Jonas Borgström, 2015-2017 The Borg Collective (see AUTH
|
||||||
# built documents.
|
# built documents.
|
||||||
#
|
#
|
||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = sw_version.split('-')[0]
|
split_char = '+' if '+' in sw_version else '-'
|
||||||
|
version = sw_version.split(split_char)[0]
|
||||||
# The full version, including alpha/beta/rc tags.
|
# The full version, including alpha/beta/rc tags.
|
||||||
release = version
|
release = version
|
||||||
|
|
||||||
|
@ -100,25 +99,21 @@ pygments_style = 'sphinx'
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
# a list of builtin themes.
|
# a list of builtin themes.
|
||||||
#html_theme = ''
|
import guzzle_sphinx_theme
|
||||||
if not on_rtd: # only import and set the theme if we're building docs locally
|
|
||||||
import sphinx_rtd_theme
|
html_theme_path = guzzle_sphinx_theme.html_theme_path()
|
||||||
html_theme = 'sphinx_rtd_theme'
|
html_theme = 'guzzle_sphinx_theme'
|
||||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
||||||
html_style = 'css/borg.css'
|
|
||||||
else:
|
def setup(app):
|
||||||
html_context = {
|
app.add_stylesheet('css/borg.css')
|
||||||
'css_files': [
|
|
||||||
'https://media.readthedocs.org/css/sphinx_rtd_theme.css',
|
|
||||||
'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
|
|
||||||
'_static/css/borg.css',
|
|
||||||
],
|
|
||||||
}
|
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a 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
|
# further. For a list of options available for each theme, see the
|
||||||
# documentation.
|
# documentation.
|
||||||
#html_theme_options = {}
|
html_theme_options = {
|
||||||
|
'project_nav_name': 'Borg %s' % version,
|
||||||
|
}
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
#html_theme_path = ['_themes']
|
#html_theme_path = ['_themes']
|
||||||
|
@ -132,7 +127,7 @@ else:
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
# of the sidebar.
|
# of the sidebar.
|
||||||
html_logo = '_static/logo.png'
|
html_logo = '_static/logo.svg'
|
||||||
|
|
||||||
# The name of an image file (within the static path) to use as favicon of the
|
# 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
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
|
@ -156,9 +151,9 @@ html_use_smartypants = True
|
||||||
|
|
||||||
# Custom sidebar templates, maps document names to template names.
|
# Custom sidebar templates, maps document names to template names.
|
||||||
html_sidebars = {
|
html_sidebars = {
|
||||||
'index': ['sidebarlogo.html', 'sidebarusefullinks.html', 'searchbox.html'],
|
'**': ['logo-text.html', 'searchbox.html', 'globaltoc.html'],
|
||||||
'**': ['sidebarlogo.html', 'relations.html', 'searchbox.html', 'localtoc.html', 'sidebarusefullinks.html']
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Additional templates that should be rendered to pages, maps page names to
|
# Additional templates that should be rendered to pages, maps page names to
|
||||||
# template names.
|
# template names.
|
||||||
#html_additional_pages = {}
|
#html_additional_pages = {}
|
||||||
|
@ -248,7 +243,13 @@ man_pages = [
|
||||||
1),
|
1),
|
||||||
]
|
]
|
||||||
|
|
||||||
extensions = ['sphinx.ext.extlinks', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
|
extensions = [
|
||||||
|
'sphinx.ext.extlinks',
|
||||||
|
'sphinx.ext.autodoc',
|
||||||
|
'sphinx.ext.todo',
|
||||||
|
'sphinx.ext.coverage',
|
||||||
|
'sphinx.ext.viewcode',
|
||||||
|
]
|
||||||
|
|
||||||
extlinks = {
|
extlinks = {
|
||||||
'issue': ('https://github.com/borgbackup/borg/issues/%s', '#'),
|
'issue': ('https://github.com/borgbackup/borg/issues/%s', '#'),
|
||||||
|
|
|
@ -0,0 +1,2 @@
|
||||||
|
sphinx
|
||||||
|
guzzle_sphinx_theme
|
Loading…
Reference in New Issue