Browse Source

Updated docs/_theme/ADCTheme

Ask Solem 15 năm trước cách đây
mục cha
commit
584c9402ac

+ 25 - 0
docs/_theme/ADCTheme/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2009, Corey Oordt
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, 
+      this list of conditions and the following disclaimer in the documentation 
+      and/or other materials provided with the distribution.
+    * Neither the name of Corey Oordt nor the names of its contributors 
+      may be used to endorse or promote products derived from this software 
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+ 23 - 0
docs/_theme/ADCTheme/README.rst

@@ -14,10 +14,33 @@ If you want to install this theme somewhere else, you will have to modify the ``
 
     templates_path = ['/absolute/path/to/dir/','relative/path/']
 
+<<<<<<< HEAD
 Making Sphinx Use the Theme
 ---------------------------
 
 Edit the ``conf.py`` file and make the following setting: ::
+=======
+Install Directly in Your Documentation
+--------------------------------------
+
+If you want to include the files directly in the documentation, so another person can build your documentation, it is easy.
+
+ 1. Copy over everything in the ``static`` directory into the ``_static`` directory of your documentation's source folder.
+
+ 2. Copy the ``layout.html`` file into the ``_templates`` directory of your documentation's source folder.
+
+ 3. Alter your ``conf.py`` ::
+
+        html_theme = 'basic'
+
+    instead of ``'ADCtheme'``.
+
+
+Making Sphinx Use the Theme
+---------------------------
+
+If you aren't installing the files directly into your documentation, edit the ``conf.py`` file and make the following setting: ::
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 
     html_theme = 'ADCtheme'
 

+ 13 - 0
docs/_theme/ADCTheme/layout.html

@@ -28,6 +28,10 @@
     {%- if prev %}
     <link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}" />
     {%- endif %}
+<<<<<<< HEAD
+=======
+    <link media="only screen and (max-device-width: 480px)" href="{{ pathto('_static/mobile.css', 1) }}" type="text/css" rel="stylesheet" />
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 {%- endblock %}
 {%- block extrahead %} {% endblock %}
 {%- block header %}{% endblock %}
@@ -135,9 +139,18 @@
 {%- block footer %}
 	<div id="breadcrumbs">
 		{%- for parent in parents %}
+<<<<<<< HEAD
 		<a href="{{ parent.link|e }}" {{ accesskey("U") }}>{{ parent.title }}</a><img src="triangle_closed.png" alt="Right arrow">
 		{%- endfor %}
 		<a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>
 		</ul>
 	</div>
+=======
+		<a href="{{ parent.link|e }}" {{ accesskey("U") }}>{{ parent.title|safe }}</a><img src="{{ pathto('_static/triangle_closed.png', 1) }}" height="9" width="9" alt="&gt;">
+		{%- endfor %}
+		{{ title|safe|e }}
+		</ul>
+	</div>
+	<script type="text/javascript" charset="utf-8" src="{{ pathto('_static/toc.js', 1) }}"></script>
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 {%- endblock %}

+ 66 - 1
docs/_theme/ADCTheme/static/adctheme.css

@@ -2,7 +2,16 @@
  * Sphinx stylesheet -- basic theme
  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  */
-
+<<<<<<< HEAD
+
+=======
+ h3 {
+     color:#000000;
+     font-size: 17px;
+     margin-bottom:0.5em;
+     margin-top:2em;
+ }
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 /* -- main layout ----------------------------------------------------------- */
 
 div.clearer {
@@ -72,10 +81,20 @@ li#toc_button .headerButton a {
     float: left;
     padding-left:15px;
     border-right:1px solid #ACACAC;
+<<<<<<< HEAD
     background:transparent url(triangle_closed.png) no-repeat scroll 4px 6px;
 }
 
 
+=======
+    background:transparent url(triangle_open.png) no-repeat scroll 4px 6px;
+}
+
+li#toc_button .headerButton a:hover {
+    background-color: #787878;
+    color: white;
+}
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 
 li#page_buttons {
 position:absolute;
@@ -104,7 +123,13 @@ right:0;
 #breadcrumbs a:hover {
     text-decoration: underline;
 }
+<<<<<<< HEAD
 
+=======
+#breadcrumbs img {
+    padding-left: 3px;
+}
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 /* -- sidebar --------------------------------------------------------------- */
 #sphinxsidebar {
     position: absolute;
@@ -447,6 +472,10 @@ dl {
 
 dd p {
     margin-top: 0px;
+<<<<<<< HEAD
+=======
+    font-size: 12px;
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 }
 
 dd ul, dd table {
@@ -457,6 +486,10 @@ dd {
     margin-top: 3px;
     margin-bottom: 10px;
     margin-left: 30px;
+<<<<<<< HEAD
+=======
+    font-size: 12px;
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 }
 
 dt:target, .highlight {
@@ -465,9 +498,18 @@ dt:target, .highlight {
 
 dl.glossary dt {
     font-weight: bold;
+<<<<<<< HEAD
     font-size: 1.1em;
 }
 
+=======
+    font-size: 0.8em;
+}
+
+dl.glossary dd {
+	font-size:12px;
+}
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 .field-list ul {
     vertical-align: top;
     margin: 0;
@@ -532,10 +574,22 @@ table.highlighttable td {
     padding: 0 0.5em 0 0.5em;
 }
 
+<<<<<<< HEAD
 tt.descname {
     background-color: transparent;
     font-weight: bold;
     font-size: 1.2em;
+=======
+tt {
+	font-family:"Bitstream Vera Sans Mono",Monaco,"Lucida Console",Courier,Consolas,monospace;
+
+}
+
+tt.descname {
+    background-color: transparent;
+    font-weight: bold;
+    font-size: 1em;
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 }
 
 tt.descclassname {
@@ -589,11 +643,15 @@ body {
 
 dl.class dt {
     padding: 3px;
+<<<<<<< HEAD
     border-top: 2px solid #999;
 }
 
 tt.descname {
     font-size: 1em;
+=======
+/*    border-top: 2px solid #999;*/
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 }
 
 em.property {
@@ -601,6 +659,10 @@ em.property {
 }
 
 dl.class dd p {
+<<<<<<< HEAD
+=======
+	margin-top: 6px;
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 }
 
 dl.class dd dl.exception dt {
@@ -735,9 +797,12 @@ font-variant:normal;
 font-weight:normal;
 line-height:normal;
 }
+<<<<<<< HEAD
 li > p {
 display:inline;
 }
+=======
+>>>>>>> 12ce4b1... Updated docs/_theme/ADCTheme
 li p {
 margin-top:8px;
 }

+ 17 - 0
docs/_theme/ADCTheme/static/mobile.css

@@ -0,0 +1,17 @@
+/*
+ * CSS adjustments (overrides) for mobile browsers that cannot handle
+ * fix-positioned div's very well.
+ * This makes long pages scrollable on mobile browsers.
+ */
+
+#breadcrumbs {
+	display: none !important;
+}
+
+.document {
+    bottom: inherit !important;
+}
+
+#sphinxsidebar {
+    bottom: inherit !important;
+}

+ 20 - 0
docs/_theme/ADCTheme/static/toc.js

@@ -0,0 +1,20 @@
+var TOC = {
+    load: function () {
+        $('#toc_button').click(TOC.toggle);
+    },
+    
+    toggle: function () {
+        if ($('#sphinxsidebar').toggle().is(':hidden')) {
+            $('div.document').css('left', "0px");
+            $('toc_button').removeClass("open");
+        } else {
+            $('div.document').css('left', "230px");
+            $('#toc_button').addClass("open");
+        }
+        return $('#sphinxsidebar');
+    }
+};
+
+$(document).ready(function () {
+    TOC.load();
+});