Selaa lähdekoodia

A new Attic sphinx theme

Jonas Borgström 12 vuotta sitten
vanhempi
sitoutus
e016a4ee92

+ 6 - 0
docs/_themes/attic/sidebarlogo.html

@@ -0,0 +1,6 @@
+<div class="sidebarlogo">
+  <a href="{{ pathto('index') }}">
+  <div class="title">Attic</div>
+  <div class="subtitle">Documentation</div>
+</a>
+</div>

+ 7 - 0
docs/_themes/attic/sidebarusefullinks.html

@@ -0,0 +1,7 @@
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="https://pypi.python.org/pypi/Attic">Attic @ PyPI</a></li>
+  <li><a href="https://github.com/jborg/attic">Attic @ github</a></li>
+  <li><a href="https://pythonhosted.org/Attic">Online Documentation</a></li>
+  <li><a href="https://github.com/jborg/attic/issues">Issue Tracker</a></li>
+</ul>

+ 88 - 0
docs/_themes/attic/static/attic.css_t

@@ -0,0 +1,88 @@
+@import url("basic.css");
+
+body {
+  font-family: Arial, Sans-Serif;
+  background-color: white;
+  margin: 0;
+  padding: 0;
+}
+div.related {
+  display: none;
+  background-color: black;
+  padding: .4em;
+  width: 800px;
+  margin: 0 auto;
+}
+div.related a {
+  color: white;
+  text-decoration: none;
+}
+div.document {
+  background-color: white;
+  width: 850px;
+  margin: 0 auto;
+  padding-top: 1em;
+}
+
+div.documentwrapper {
+  float: right;
+  width: 600px;
+}
+div.sphinxsidebar {
+  margin-left: 0;
+  parring-right: 20px;
+  width: 230px;
+}
+
+h1, h2, h3 {
+  font-weight: normal;
+  color: #444;
+}
+
+ul {
+  padding-left: 1.2em;
+  margin-bottom: .3em;
+}
+ul ul {
+  font-size: 95%;
+}
+li {
+  margin: .1em 0;
+}
+
+a:link, a:visited {
+  color: #00608f;
+  text-decoration: none;
+}
+a:hover {
+  color: #00B0E4;
+  border-bottom: 1px dotted #00B0E4;
+}
+
+div.sphinxsidebar a:link, div.sphinxsidebar a:visited {
+  color: #555;
+  border-bottom: 1px dotted #555;
+}
+
+
+pre {
+  border: 1px solid #ccc;
+  padding: .6em;
+  background: black;
+  color: #ddd;
+  border-radius: .4em;
+  box-shadow: 2px 2px #ddd;
+
+}
+
+div.note {
+  background-color: #eee;
+  border: 1px solid #ccc;
+}
+div.sidebarlogo .title {
+  font-size: 250%;
+}
+div.sidebarlogo .subtitle {
+  font-style: italic;
+  color: #777;
+}

+ 6 - 0
docs/_themes/attic/theme.conf

@@ -0,0 +1,6 @@
+[theme]
+inherit = basic
+stylesheet = attic.css
+pygments_style = tango
+
+[options]

+ 10 - 8
docs/conf.py

@@ -91,7 +91,7 @@ pygments_style = 'sphinx'
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'nature'
+html_theme = 'attic'
 
 # 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
@@ -99,7 +99,7 @@ html_theme = 'nature'
 #html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+html_theme_path = ['_themes']
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -131,8 +131,10 @@ html_static_path = ['_static']
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
+html_sidebars = {
+    'index': ['sidebarlogo.html', 'sidebarusefullinks.html', 'searchbox.html'],
+    '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html', 'searchbox.html']
+}
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 #html_additional_pages = {}
@@ -141,19 +143,19 @@ html_static_path = ['_static']
 #html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+html_use_index = False
 
 # If true, the index is split into individual pages for each letter.
 #html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+html_show_sphinx = False
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+html_show_copyright = False
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the

+ 2 - 2
docs/index.rst

@@ -1,7 +1,7 @@
 .. include:: global.rst.inc
 
-Attic
-=====
+Welcome to Attic
+================
 |project_name| is a deduplicating backup program written in Python.
 The main goal of |project_name| is to provide an efficient and secure way
 to backup data. The data deduplication technique used makes |project_name|