Ver código fonte

[docs] Some user-friendly changes to the documentation.

 - Added parmalinks (closes #1527)
 - Changed the 'fork us on github' button to 'Edit this page on github', so people can edit quickly (closes #1532)
- Changed the favicon
Thatcher Peskens 12 anos atrás
pai
commit
f14db49346

+ 2 - 3
docs/sources/conf.py

@@ -18,7 +18,7 @@ import sys, os
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, os.path.abspath('.'))
 
-# -- General configuration -----------------------------------------------------
+# -- General configuratiofn -----------------------------------------------------
 
 
 
@@ -52,8 +52,7 @@ source_suffix = '.rst'
 #source_encoding = 'utf-8-sig'
 
 #disable the parmalinks on headers, I find them really annoying
-html_add_permalinks = None
-
+html_add_permalinks = u'¶'
 
 # The master toctree document.
 master_doc = 'toctree'

+ 2 - 2
docs/theme/docker/layout.html

@@ -70,8 +70,8 @@
                 <ul class="nav">
                     <li id="nav-introduction"><a href="http://www.docker.io/" title="Docker Homepage">Home</a></li>
                     <li id="nav-about"><a href="http://www.docker.io/about/" title="About">About</a></li>
-                    <li id="nav-community"><a href="http://www.docker.io/community/" title="Community">Community</a></li>
                     <li id="nav-gettingstarted"><a href="http://www.docker.io/gettingstarted/">Getting started</a></li>
+                    <li id="nav-community"><a href="http://www.docker.io/community/" title="Community">Community</a></li>
                     <li id="nav-documentation" class="active"><a href="http://docs.docker.io/en/latest/">Documentation</a></li>
                     <li id="nav-blog"><a href="http://blog.docker.io/" title="Docker Blog">Blog</a></li>
                     <li id="nav-index"><a href="http://index.docker.io/" title="Docker Image Index, find images here">INDEX <img class="inline-icon" src="{{ pathto('_static/img/external-link-icon.png', 1) }}" title="external link"> </a></li>
@@ -93,7 +93,7 @@
         <div class="span12 titlebar">
             <!--<span class="pull-right" style="margin-left: 20px; font-size: 20px">{{version}}</span>-->
             <div class="pull-right" id="fork-us" style="margin-top: 16px; margin-right: 16px;">
-                <a  href="http://github.com/dotcloud/docker/"><img src="{{ pathto('_static/img/fork-us.png', 1) }}"> Fork us on Github</a>
+                <a  href="https://github.com/dotcloud/docker/blob/master/docs/sources/{{ pagename }}.rst"><img src="{{ pathto('_static/img/fork-us.png', 1) }}"> Edit this page on Github</a>
             </div>
             <h1 class="pageheader"><a href="http://docs.docker.io/en/latest/" title="Documentation" style="color: white;">DOCUMENTATION</a></h1>
 

+ 16 - 0
docs/theme/docker/static/css/main.css

@@ -375,3 +375,19 @@ section.header {
 table th {
   text-align: left;
 }
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink {
+  visibility: visible;
+}
+.headerlink {
+  font-size: smaller;
+  color: #666;
+  font-weight: bold;
+  float: right;
+  visibility: hidden;
+}

+ 18 - 0
docs/theme/docker/static/css/main.less

@@ -486,4 +486,22 @@ section.header {
 /* Misc fixes */
 table th {
   text-align: left;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink {
+    visibility: visible;
+}
+
+.headerlink {
+  font-size: smaller;
+  color: #666;
+  font-weight: bold;
+  float: right;
+  visibility: hidden;
 }

BIN
docs/theme/docker/static/favicon.png