Skip to content

Commit f14db49

Browse files
dhrpdhrp
committed
[docs] Some user-friendly changes to the documentation.
 - Added parmalinks (closes moby#1527) - Changed the 'fork us on github' button to 'Edit this page on github', so people can edit quickly (closes moby#1532) - Changed the favicon
1 parent fd5099c commit f14db49

5 files changed

Lines changed: 38 additions & 5 deletions

File tree

‎docs/sources/conf.py‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# documentation root, use os.path.abspath to make it absolute, like shown here.
1919
#sys.path.insert(0, os.path.abspath('.'))
2020

21-
# -- General configuration -----------------------------------------------------
21+
# -- General configuratiofn -----------------------------------------------------
2222

2323

2424

@@ -52,8 +52,7 @@
5252
#source_encoding = 'utf-8-sig'
5353

5454
#disable the parmalinks on headers, I find them really annoying
55-
html_add_permalinks = None
56-
55+
html_add_permalinks = u'¶'
5756

5857
# The master toctree document.
5958
master_doc = 'toctree'

‎docs/theme/docker/layout.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@
7070
<ul class="nav">
7171
<li id="nav-introduction"><a href="http://www.docker.io/" title="Docker Homepage">Home</a></li>
7272
<li id="nav-about"><a href="http://www.docker.io/about/" title="About">About</a></li>
73-
<li id="nav-community"><a href="http://www.docker.io/community/" title="Community">Community</a></li>
7473
<li id="nav-gettingstarted"><a href="http://www.docker.io/gettingstarted/">Getting started</a></li>
74+
<li id="nav-community"><a href="http://www.docker.io/community/" title="Community">Community</a></li>
7575
<li id="nav-documentation" class="active"><a href="http://docs.docker.io/en/latest/">Documentation</a></li>
7676
<li id="nav-blog"><a href="http://blog.docker.io/" title="Docker Blog">Blog</a></li>
7777
<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 @@
9393
<div class="span12 titlebar">
9494
<!--<span class="pull-right" style="margin-left: 20px; font-size: 20px">{{version}}</span>-->
9595
<div class="pull-right" id="fork-us" style="margin-top: 16px; margin-right: 16px;">
96-
<a href="http://github.com/dotcloud/docker/"><img src="{{ pathto('_static/img/fork-us.png', 1) }}"> Fork us on Github</a>
96+
<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>
9797
</div>
9898
<h1 class="pageheader"><a href="http://docs.docker.io/en/latest/" title="Documentation" style="color: white;">DOCUMENTATION</a></h1>
9999

‎docs/theme/docker/static/css/main.css‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,3 +375,19 @@ section.header {
375375
table th {
376376
text-align: left;
377377
}
378+
h1:hover > a.headerlink,
379+
h2:hover > a.headerlink,
380+
h3:hover > a.headerlink,
381+
h4:hover > a.headerlink,
382+
h5:hover > a.headerlink,
383+
h6:hover > a.headerlink,
384+
dt:hover > a.headerlink {
385+
visibility: visible;
386+
}
387+
.headerlink {
388+
font-size: smaller;
389+
color: #666;
390+
font-weight: bold;
391+
float: right;
392+
visibility: hidden;
393+
}

‎docs/theme/docker/static/css/main.less‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -486,4 +486,22 @@ section.header {
486486
/* Misc fixes */
487487
table th {
488488
text-align: left;
489+
}
490+
491+
h1:hover > a.headerlink,
492+
h2:hover > a.headerlink,
493+
h3:hover > a.headerlink,
494+
h4:hover > a.headerlink,
495+
h5:hover > a.headerlink,
496+
h6:hover > a.headerlink,
497+
dt:hover > a.headerlink {
498+
visibility: visible;
499+
}
500+
501+
.headerlink {
502+
font-size: smaller;
503+
color: #666;
504+
font-weight: bold;
505+
float: right;
506+
visibility: hidden;
489507
}

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

1.05 KB
Loading

0 commit comments

Comments
 (0)