www: Folder and script for libreplan.org documentation
New folder with link to different documentation files in the source code. It also includes a script to generate the HTML files that will be available on-line at http://libreplan.org FEA: ItEr76S03Community
This commit is contained in:
parent
23d8c3b972
commit
205a3f4b6a
14 changed files with 314 additions and 0 deletions
1
www/AUTHORS
Symbolic link
1
www/AUTHORS
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../AUTHORS
|
||||||
1
www/HACKING
Symbolic link
1
www/HACKING
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../HACKING
|
||||||
1
www/INSTALL
Symbolic link
1
www/INSTALL
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../INSTALL
|
||||||
1
www/NEWS
Symbolic link
1
www/NEWS
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../NEWS
|
||||||
1
www/README
Symbolic link
1
www/README
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../README
|
||||||
1
www/TODO
Symbolic link
1
www/TODO
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../TODO
|
||||||
1
www/UPDATE
Symbolic link
1
www/UPDATE
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../UPDATE
|
||||||
51
www/generate-html.sh
Executable file
51
www/generate-html.sh
Executable file
|
|
@ -0,0 +1,51 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
FILES="\
|
||||||
|
AUTHORS \
|
||||||
|
HACKING \
|
||||||
|
INSTALL \
|
||||||
|
NEWS \
|
||||||
|
README \
|
||||||
|
TODO \
|
||||||
|
UPDATE \
|
||||||
|
howto-create-a-new-report-in-libreplan.rst \
|
||||||
|
howto-develop-a-use-case-in-libreplan.rst \
|
||||||
|
howto-start-development-with-eclipse.rst \
|
||||||
|
libreplan-web-services.rst \
|
||||||
|
"
|
||||||
|
|
||||||
|
TMP=`mktemp`
|
||||||
|
|
||||||
|
for file in $FILES
|
||||||
|
do
|
||||||
|
output=${file%\.rst}.html
|
||||||
|
|
||||||
|
# Backup file
|
||||||
|
if [ -s $output ]
|
||||||
|
then
|
||||||
|
mv $output $output.bak
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Generate HTML
|
||||||
|
rst2html --link-stylesheet --stylesheet-path=lsr.css $file $output > /dev/null 2>$TMP
|
||||||
|
|
||||||
|
# Check errors output
|
||||||
|
if [ -s $TMP ]
|
||||||
|
then
|
||||||
|
# Back to original file if errors
|
||||||
|
echo "Parsing errors in file \"$file\" keeping old file"
|
||||||
|
if [ -s $output.bak ]
|
||||||
|
then
|
||||||
|
mv $output.bak $output
|
||||||
|
fi
|
||||||
|
rm $TMP
|
||||||
|
else
|
||||||
|
# Remove backup
|
||||||
|
if [ -s $output.bak ]
|
||||||
|
then
|
||||||
|
rm $output.bak
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
rm $TMP
|
||||||
1
www/howto-create-a-new-report-in-libreplan.rst
Symbolic link
1
www/howto-create-a-new-report-in-libreplan.rst
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../doc/src/technical/howto-create-a-new-report-in-libreplan.rst
|
||||||
1
www/howto-develop-a-use-case-in-libreplan.rst
Symbolic link
1
www/howto-develop-a-use-case-in-libreplan.rst
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../doc/src/technical/howto-develop-a-use-case-in-libreplan.rst
|
||||||
1
www/howto-start-development-with-eclipse.rst
Symbolic link
1
www/howto-start-development-with-eclipse.rst
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../doc/src/technical/howto-start-development-with-eclipse.rst
|
||||||
1
www/img
Symbolic link
1
www/img
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../doc/src/technical/img/
|
||||||
1
www/libreplan-web-services.rst
Symbolic link
1
www/libreplan-web-services.rst
Symbolic link
|
|
@ -0,0 +1 @@
|
||||||
|
../scripts/rest-clients/README
|
||||||
251
www/lsr.css
Normal file
251
www/lsr.css
Normal file
|
|
@ -0,0 +1,251 @@
|
||||||
|
/*
|
||||||
|
Author: Peter Parente
|
||||||
|
Date: 2008/01/22
|
||||||
|
Version: 1.0
|
||||||
|
Copyright: This stylesheet has been placed in the public domain - free to edit and use for all uses.
|
||||||
|
*/
|
||||||
|
|
||||||
|
body {
|
||||||
|
font: 0.8em Verdana, Tahoma, sans-serif;
|
||||||
|
background: #ffffff;
|
||||||
|
color: black;
|
||||||
|
margin: 2em;
|
||||||
|
/* padding: 0em 2em; */
|
||||||
|
}
|
||||||
|
|
||||||
|
p.topic-title {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.docinfo {
|
||||||
|
text-align: left;
|
||||||
|
margin: 2em 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
a[href] {
|
||||||
|
color: #436976;
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
a.toc-backref {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 a[href] {
|
||||||
|
color: #003a6b;
|
||||||
|
text-decoration: none;
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
a.strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
img {
|
||||||
|
margin: 0;
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
p {
|
||||||
|
margin: 0.5em 0 1em 0;
|
||||||
|
line-height: 1.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
p a:visited {
|
||||||
|
color: purple;
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
p a:active {
|
||||||
|
color: red;
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
p img {
|
||||||
|
border: 0;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.rubric {
|
||||||
|
font-weight: bold;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1.title {
|
||||||
|
color: #003a6b;
|
||||||
|
font-size: 250%;
|
||||||
|
margin-bottom: 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h2.subtitle {
|
||||||
|
color: #003a6b;
|
||||||
|
border-bottom: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
color: #555;
|
||||||
|
background-color: transparent;
|
||||||
|
margin: 0em;
|
||||||
|
padding-top: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 160%;
|
||||||
|
margin-bottom: 0.5em;
|
||||||
|
border-bottom: 2px solid #aaa;
|
||||||
|
}
|
||||||
|
|
||||||
|
h2 {
|
||||||
|
font-size: 140%;
|
||||||
|
margin-bottom: 0.5em;
|
||||||
|
border-bottom: 1px solid #aaa;
|
||||||
|
}
|
||||||
|
|
||||||
|
h3 {
|
||||||
|
font-size: 130%;
|
||||||
|
margin-bottom: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h4 {
|
||||||
|
font-size: 110%;
|
||||||
|
font-weight: bold;
|
||||||
|
margin-bottom: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h5 {
|
||||||
|
font-size: 105%;
|
||||||
|
font-weight: bold;
|
||||||
|
margin-bottom: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h6 {
|
||||||
|
font-size: 100%;
|
||||||
|
font-weight: bold;
|
||||||
|
margin-bottom: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dt {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
dd {
|
||||||
|
margin-bottom: 1.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.admonition, div.note, div.tip, div.caution, div.important, div.warning {
|
||||||
|
margin: 2em 2em;
|
||||||
|
padding: 0em 1em;
|
||||||
|
border-top: 1px solid #aaa;
|
||||||
|
border-left: 1px solid #aaa;
|
||||||
|
border-bottom: 2px solid #555;
|
||||||
|
border-right: 2px solid #555;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.important {
|
||||||
|
background: transparent url('../images/important.png') 10px 2px no-repeat;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.caution {
|
||||||
|
background: transparent url('../images/caution.png') 10px 2px no-repeat;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.note {
|
||||||
|
background: transparent url('../images/note.png') 10px 2px no-repeat;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.tip {
|
||||||
|
background: transparent url('../images/tip.png') 10px 2px no-repeat;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.admonition-example {
|
||||||
|
background: transparent url('../images/tip.png') 10px 2px no-repeat;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.admonition-critical-example {
|
||||||
|
background: transparent url('../images/important.png') 10px 2px no-repeat;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.admonition-title {
|
||||||
|
font-weight: bold;
|
||||||
|
border-bottom: 1px solid #aaa;
|
||||||
|
padding-left: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.docutils {
|
||||||
|
text-align: left;
|
||||||
|
border: 1px solid gray;
|
||||||
|
border-collapse: collapse;
|
||||||
|
width: 100%;
|
||||||
|
margin: 1.5em 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.docutils caption {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.docutils td, table.docutils th {
|
||||||
|
padding: 0.25em 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.docutils th {
|
||||||
|
background-color: #dddddd;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sidebar {
|
||||||
|
width: 33%;
|
||||||
|
float: right;
|
||||||
|
margin: 0em 2em;
|
||||||
|
padding: 0em 1em;
|
||||||
|
border-top: 1px solid #aaa;
|
||||||
|
border-left: 1px solid #aaa;
|
||||||
|
border-bottom: 2px solid #555;
|
||||||
|
border-right: 2px solid #555;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.sidebar-title {
|
||||||
|
margin-bottom: 0em;
|
||||||
|
color: #003a6b;
|
||||||
|
border-bottom: 1px solid #aaa;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.sidebar-subtitle {
|
||||||
|
margin-top: 0em;
|
||||||
|
font-style: italic;
|
||||||
|
color: #003a6b;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.figure {
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.figure img {
|
||||||
|
background: #f8f8f8;
|
||||||
|
padding: 0.25em;
|
||||||
|
border: 1px solid #888;
|
||||||
|
border-radius: 5px;
|
||||||
|
-moz-border-radius: 5px;
|
||||||
|
-webkit-border-radius: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.figure img:hover {
|
||||||
|
background: #e0e0e0;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.figure p.caption {
|
||||||
|
text-align: center;
|
||||||
|
margin-top: 0.1em;
|
||||||
|
font-style: italic;
|
||||||
|
color: #444;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre.literal-block {
|
||||||
|
padding: 0.15em;
|
||||||
|
background: #f8f8f8;
|
||||||
|
border: 1px solid #dfdfdf;
|
||||||
|
border-left: 0.25em solid #dfdfdf
|
||||||
|
}
|
||||||
Loading…
Add table
Reference in a new issue