zrythm
/
zrythm-sratom
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Switch to LV2 documentation theme

zrythm_meson
David Robillard 2 years ago
parent
397ddf1157
commit
07ed82cc08
4 changed files with 35 additions and 192 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 95
      doc/_static/custom.css
  2. 57
      doc/_templates/about.html
  3. 4
      doc/c/wscript
  4. 71
      doc/conf.py.in

95
doc/_static/custom.css vendored
Unescape View File

@ -1,95 +0,0 @@ @@ -1,95 +0,0 @@
div.document {
margin: 0;
}
div.body {
margin-top: 2em;
}
div.sphinxsidebarwrapper {
background: #EEE;
}
div.sphinxsidebarwrapper p.blurb {
text-align: center;
}
div.sphinxsidebarwrapper span.logo {
display: block;
text-align: center;
font-family: Georgia, serif;
padding: 0;
font-size: 180%;
}
div.sphinxsidebar a {
border-width: 0;
}
div.sphinxsidebar li {
color: #444;
}
div.section {
margin-top: 2.5em;
}
a.reference {
border-bottom: none;
}
code.xref {
font-weight: normal;
background-color: #F8F8F8;
padding: 0.1em 0 0.1em 0;
}
div.section > dl.c > dt:first-child,
div.section > dl.cpp > dt:first-child {
background-color: #F8F8F8;
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
font-size: 0.9em;
font-weight: normal;
margin-bottom: 0.5em;
padding: 0.1em 0 0.1em 0;
}
tt.descname, tt.descclassname, code.descname, code.descclassname {
font-size: 0.9em;
}
dl.member {
margin-top: 0.5em;
}
dl.enumerator {
margin-top: 0.5em;
}
dl.field-list > dt {
padding-left: 0;
}
pre, tt, code {
background-color: #F8F8F8;
}
.toctree-l1 {
margin-top: 1.0em;
}
img.logo {
width: 6em;
}
.class {
padding-top: 1.5em;
}
.exception {
padding-top: 1.5em;
}
.class > dd > dl.function {
padding-top: 1.0em;
}

57
doc/_templates/about.html vendored
Unescape View File

@ -1,57 +0,0 @@ @@ -1,57 +0,0 @@
{% if theme_logo %}
<p class="logo">
<a href="{{ pathto(master_doc) }}">
<img class="logo" src="{{ pathto('_static/' ~ theme_logo, 1) }}" alt="Logo"/>
{% if theme_logo_name|lower == 'true' %}
<span class="logo logo-name">{{ project }}</span>
{% endif %}
</a>
</p>
{% else %}
<h1 class="logo"><a href="{{ pathto(master_doc) }}">{{ project }}</a></h1>
{% endif %}
{% if theme_description %}
<p class="blurb">{{ theme_description }}</p>
{% endif %}
{% if theme_github_user and theme_github_repo %}
{% if theme_github_button|lower == 'true' %}
<p>
<iframe src="https://ghbtns.com/github-btn.html?user={{ theme_github_user }}&repo={{ theme_github_repo }}&type={{ theme_github_type }}&count={{ theme_github_count }}&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>
{% endif %}
{% endif %}
{% if theme_travis_button|lower != 'false' %}
{% if theme_travis_button|lower == 'true' %}
{% set path = theme_github_user + '/' + theme_github_repo %}
{% else %}
{% set path = theme_travis_button %}
{% endif %}
<p>
<a class="badge" href="https://travis-ci.org/{{ path }}">
<img
alt="https://secure.travis-ci.org/{{ path }}.svg?branch={{ theme_badge_branch }}"
src="https://secure.travis-ci.org/{{ path }}.svg?branch={{ theme_badge_branch }}"
/>
</a>
</p>
{% endif %}
{% if theme_codecov_button|lower != 'false' %}
{% if theme_codecov_button|lower == 'true' %}
{% set path = theme_github_user + '/' + theme_github_repo %}
{% else %}
{% set path = theme_codecov_button %}
{% endif %}
<p>
<a class="badge" href="https://codecov.io/github/{{ path }}">
<img
alt="https://codecov.io/github/{{ path }}/coverage.svg?branch={{ theme_badge_branch }}"
src="https://codecov.io/github/{{ path }}/coverage.svg?branch={{ theme_badge_branch }}"
/>
</a>
</p>
{% endif %}

4
doc/c/wscript
Unescape View File

@ -5,8 +5,6 @@ def build(bld): @@ -5,8 +5,6 @@ def build(bld):
index_xml = bld.path.get_bld().make_node("xml/index.xml")
files = [
("../_static/custom.css", "sphinx/_static/custom.css"),
("../_templates/about.html", "sphinx/_templates/about.html"),
("../sratom.rst", "sphinx/sratom.rst"),
("index.rst", "sphinx/index.rst"),
("overview.rst", "sphinx/overview.rst"),
@ -37,5 +35,5 @@ def build(bld): @@ -37,5 +35,5 @@ def build(bld):
bld(features="sphinx",
sphinx_source=bld.path.get_bld().make_node("sphinx"),
sphinx_output_format="singlehtml",
sphinx_options=["-E", "-q"],
sphinx_options=["-E", "-q", "-t", "singlehtml"],
install_path=doc_dir + "c/singlehtml/")

71
doc/conf.py.in
Unescape View File

@ -7,15 +7,12 @@ release = "@SRATOM_VERSION@" @@ -7,15 +7,12 @@ release = "@SRATOM_VERSION@"
# General configuration
exclude_patterns = ["xml"]
language = "en"
extensions = [
# 'sphinx_rtd_theme',
]
# Enable nitpicky mode to get warnings about broken links
# Unfortunately this means we need to explicitly ignore everything external
nitpicky = True
pygments_style = "friendly"
# Ignore everything opaque or external for nitpicky mode
_opaque = [
"LV2_Atom",
"LV2_Atom_Forge",
@ -36,45 +33,45 @@ _opaque = [ @@ -36,45 +33,45 @@ _opaque = [
nitpick_ignore = list(map(lambda x: ("c:identifier", x), _opaque))
templates_path = ["_templates"]
pygments_style = "friendly"
# HTML output
exclude_patterns = ["xml"]
html_static_path = ["_static"]
html_theme = "sphinx_lv2_theme"
html_copy_source = False
html_short_title = "Sratom"
html_theme = "alabaster"
# html_theme = "sphinx_rtd_theme"
if html_theme == "alabaster":
html_theme_options = {
"description": "A small library for serialising LV2 atoms to and from RDF",
"donate_url": "http://drobilla.net/pages/donate.html",
# "github_repo": "sratom",
# "github_user": "lv2",
# "logo": "sratom.svg",
"logo_name": True,
"logo_text_align": "center",
"page_width": "80em - 20em",
"sidebar_width": "20em",
}
if tags.has("singlehtml"):
html_sidebars = {
"**": [
"about.html",
"localtoc.html",
"donate.html",
"globaltoc.html",
]
}
elif html_theme == "sphinx_rtd_theme":
html_theme_options = {
"body_max_width": "48em",
"body_min_width": "48em",
"description": "A small library for serialising LV2 atoms to and from RDF",
"globaltoc_collapse": False,
"globaltoc_maxdepth": 3,
"logo_name": True,
"nosidebar": False,
"page_width": "80em",
"show_footer_version": True,
"show_logo_version": False,
"sidebar_width": "18em",
}
else:
html_theme_options = {
"sticky_navigation": False,
"collapse_navigation": False,
"navigation_depth": 4,
"display_version": True,
"body_max_width": "60em",
"body_min_width": "40em",
"description": "A small library for serialising LV2 atoms to and from RDF",
"globaltoc_collapse": True,
"globaltoc_maxdepth": 1,
"logo_name": True,
"nosidebar": True,
"page_width": "60em",
"show_footer_version": True,
"show_logo_version": False,
"sidebar_width": "14em",
}

Write Preview
Loading…
Cancel
Save