Skip to content

Commit

Permalink
Add HTML documentation to the public website.
Browse files Browse the repository at this point in the history
  • Loading branch information
rwmjones committed Dec 7, 2010
1 parent 75c179d commit 5574d14
Show file tree
Hide file tree
Showing 4 changed files with 193 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -28,6 +28,8 @@ febootstrap*.txt
febootstrap-*.tar.gz
helper/febootstrap-supermin-helper
helper/init
html/febootstrap-supermin-helper.8.html
html/febootstrap.8.html
lib/alloca.h
lib/arg-nonnull.h
lib/c++defs.h
Expand All @@ -45,6 +47,7 @@ lib/wchar.h
INSTALL
install-sh
missing
pod2htm?.tmp
stamp-h1
/warn-on-use.h
examples/guestfs
Expand Down
24 changes: 24 additions & 0 deletions Makefile.am
Expand Up @@ -94,4 +94,28 @@ febootstrap.8: febootstrap.pod
-c "Virtualization Support" \
--release "$(PACKAGE_NAME)-$(PACKAGE_VERSION)" \
$< > $@

noinst_DATA = \
html/febootstrap.8.html

html/febootstrap.8.html: febootstrap.pod
mkdir -p html
pod2html \
--css 'pod.css' \
--htmldir html \
--outfile html/febootstrap.8.html \
febootstrap.pod

endif

# Maintainer website update.
HTMLFILES = \
html/febootstrap.8.html \
html/febootstrap-supermin-helper.8.html

WEBSITEDIR = $(HOME)/d/redhat/websites/libguestfs

website: $(HTMLFILES)
cp $(HTMLFILES) $(WEBSITEDIR)

CLEANFILES += $(HTMLFILES) pod2*.tmp
11 changes: 11 additions & 0 deletions helper/Makefile.am
Expand Up @@ -63,6 +63,17 @@ febootstrap-supermin-helper.8: febootstrap-supermin-helper.pod
--release "$(PACKAGE_NAME)-$(PACKAGE_VERSION)" \
$< > $@

noinst_DATA = \
$(top_builddir)/html/febootstrap-supermin-helper.8.html

$(top_builddir)/html/febootstrap-supermin-helper.8.html: febootstrap-supermin-helper.pod
mkdir -p $(top_builddir)/html
cd $(top_builddir) && pod2html \
--css 'pod.css' \
--htmldir html \
--outfile html/febootstrap-supermin-helper.8.html \
helper/febootstrap-supermin-helper.pod

endif

EXTRA_DIST = \
Expand Down
155 changes: 155 additions & 0 deletions html/pod.css
@@ -0,0 +1,155 @@
/* CSS to make pod2html files look a little bit better. */

body {
margin-left: 4em;
}

body p, body ul, ol, body dl {
margin-left: 2em;
width: 31em;
}

pre {
width: 31em;
}

li {
padding-bottom: 0.5em;
}

/* Code sections. */

pre {
background-color: #f8f8f8;
color: rgb(204,0,0);
font-weight: 550;
border-left: 6px solid rgb(204,64,64);
padding: 6px;
margin-left: 1em;
font-size: 120%;
}

/* Bold, italic in man pages. */
b, strong {
color: rgb(204,0,0);
}

i, em {
color: rgb(204,0,0);
}

/* Name heading. */

body > h1:first-of-type {
display: none;
}

body > h1:first-of-type + p {
font-size: 125%;
font-weight: bold;
color: rgb(204,0,0);
margin-left: -32px;
}

/* Warning heading in man pages. */
a[name="warning"] {
-moz-border-radius-topleft: 5px;
-moz-border-radius-topright: 5px;
border-radius-topleft: 5px;
border-radius-topright: 5px;

color: white;
background-color: rgb(204,0,0);
}
a[name="warning"]:before {
content: "\00a0\00a0\00a0";
}
a[name="warning"]:after {
content: "\00a0\00a0\00a0";
}

/* Put the index on the right hand side in a floating box. */
div[name="index"] {
float: right;
width: 18em;
border-left: 3em solid white;
background-color: #fcfcfc;
margin-top: 32px;
padding-top: 0px;
margin-left: 1em;
padding-left: 1em;
padding-right: 1em;
font-size: 90%;
}

div[name="index"] a[href] {
text-decoration: none;
}

div[name="index"] a[href]:hover {
text-decoration: underline;
}

div[name="index"] a[href]:before {
content: '#\00a0';
color: rgb(204,0,0);
font-size: x-small;
}

div[name="index"] > ul {
width: 17em;
list-style: none;
margin-left: 0px;
margin-right: 0px;
padding-left: 0px;
padding-right: 0px;
}

div[name="index"] > ul > li {
margin-bottom: 0.5em;
}

div[name="index"] > ul ul {
width: 16em;
list-style: none;
margin-left: 0px;
margin-right: 0px;
padding-left: 0px;
padding-right: 0px;
margin-bottom: 0.5em;
}

div[name="index"] > ul > ul li {
display: inline;
margin-right: 1em;
}

/*
div[name="index"] > ul > ul li:after {
color: #ccc;
content: '\2014';
}
*/

/* Get rid of those horrible <hr>'s :-( */
hr { display: none; }

/* Demote <h1>'s and set rest of headers relative. */
h1 {
font-size: 100%;
color: black;
border-bottom: solid 1px rgb(204,0,0);
}

h2 {
font-size: 95%;
border-bottom: none;
}

h3 {
font-size: 90%;
}

h4 {
font-size: 85%;
}

0 comments on commit 5574d14

Please sign in to comment.