summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPetr Šplíchal <psplicha@redhat.com>2012-02-23 16:04:32 +0100
committerPetr Šplíchal <psplicha@redhat.com>2012-02-23 16:04:32 +0100
commit2000d28b07aac78bbad238938aacfde64ff3802e (patch)
tree28dcc91f0f9c52e4ea827b10cd78abe71c13493e
parentca6950268d86eb719564914ae2be55b5d4e81552 (diff)
downloadpython-nitrate-0.7.tar.gz
python-nitrate-0.7.tar.xz
python-nitrate-0.7.zip
Style sheet for html docs plus minor adjustments0.7
-rw-r--r--Makefile7
-rw-r--r--README25
-rw-r--r--documentation/style.css53
-rw-r--r--python-nitrate.spec2
4 files changed, 71 insertions, 16 deletions
diff --git a/Makefile b/Makefile
index b399e6b..b970616 100644
--- a/Makefile
+++ b/Makefile
@@ -5,6 +5,7 @@ PUSH_URL = fedorapeople.org:public_html/python-nitrate
PACKAGE = python-nitrate-$(VERSION)
DOCS = $(TMP)/$(PACKAGE)/documentation
+CSS = --stylesheet=style.css --link-stylesheet
FILES = COPYING README \
Makefile python-nitrate.spec \
documentation examples source
@@ -15,9 +16,9 @@ build:
mkdir -p $(TMP)/{SOURCES,$(PACKAGE)}
cp -a $(FILES) $(TMP)/$(PACKAGE)
rst2man README | gzip > $(DOCS)/python-nitrate.1.gz
- rst2html README > $(DOCS)/python-nitrate.html
+ rst2html README $(CSS) > $(DOCS)/index.html
rst2man $(DOCS)/nitrate.rst | gzip > $(DOCS)/nitrate.1.gz
- rst2html $(DOCS)/nitrate.rst > $(DOCS)/nitrate.html
+ rst2html $(DOCS)/nitrate.rst $(CSS) > $(DOCS)/nitrate.html
tarball: build
cd $(TMP) && tar cfj SOURCES/$(PACKAGE).tar.bz2 $(PACKAGE)
@@ -35,7 +36,7 @@ push: packages
$(TMP)/SRPMS/$(PACKAGE)* \
$(TMP)/RPMS/noarch/$(PACKAGE)* \
$(TMP)/SOURCES/$(PACKAGE).tar.bz2 \
- $(DOCS)/*.html \
+ $(DOCS)/*.{css,html} \
$(PUSH_URL)
clean:
diff --git a/README b/README
index c84a369..88c5510 100644
--- a/README
+++ b/README
@@ -49,7 +49,7 @@ Initialize or create an object::
Default iterators provided for all container objects::
- for case in TestRun(1234)::
+ for case in TestRun(1234):
if case.automated:
case.status = Status("RUNNING")
@@ -83,7 +83,13 @@ LINKS
Project page:
http://psss.fedorapeople.org/python-nitrate/
-Nitrate test case management system:
+Git repo:
+http://fedorapeople.org/gitweb?p=psss/public_git/python-nitrate
+
+File bugs:
+https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora
+
+Nitrate:
https://fedorahosted.org/nitrate/
@@ -99,23 +105,18 @@ nitrate module features see the Python online documentation::
AUTHORS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
High-level Python module:
-Petr Šplíchal <psplicha@redhat.com>,
-Zbyšek Mráz <zmraz@redhat.com>.
+Petr Šplíchal and Zbyšek Mráz.
Low-level XMLRPC driver:
-Airald Hapairai,
-David Malcolm <dmalcolm@redhat.com>,
-Will Woods <wwoods@redhat.com>,
-Bill Peck <bpeck@redhat.com>,
-Chenxiong Qi <cqi@redhat.com>,
-Tang Chaobin <ctang@redhat.com>,
-Yuguang Wang <yuwang@redhat.com>
-and Xuqing Kuang <xuqingkuang@gmail.com>.
+Airald Hapairai, David Malcolm, Will Woods, Bill Peck, Chenxiong
+Qi, Tang Chaobin, Yuguang Wang and Xuqing Kuang.
Hope, the library will save you time and bring some joy when
writing scripts interacting with the Nitrate server. Looking
forward to your feedback, comments, suggestions and patches ;-)
+Petr Šplíchal <psplicha@redhat.com>
+
COPYRIGHT
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/documentation/style.css b/documentation/style.css
new file mode 100644
index 0000000..5dc217c
--- /dev/null
+++ b/documentation/style.css
@@ -0,0 +1,53 @@
+body {
+ font-family: "dejavu sans", sans-serif;
+ width: 80ex;
+ margin: 3em auto;
+ background-color: #eee;
+ border: 3px solid #ddd;
+}
+
+div.document {
+ padding: 3em;
+ background-color: white;
+}
+
+h1.title {
+ font-size: 200%;
+ background-color: white;
+ border: 0px;
+ margin: 0px;
+}
+
+h2.subtitle {
+ margin-top: 1ex;
+ font-size: 110%;
+}
+
+h1 {
+ font-size: 130%;
+ border-bottom: 3px solid #eee;
+ margin: 3ex 0em 0em 0em;
+}
+
+p, li {
+ line-height: 140%;
+ list-style-type: square;
+}
+
+blockquote {
+ margin: 1em;
+}
+
+pre {
+ margin-left: 3em;
+ color: #777;
+}
+
+table.docinfo {
+ display: none;
+}
+
+a {
+ color: #c00;
+ text-decoration: none;
+}
diff --git a/python-nitrate.spec b/python-nitrate.spec
index 1220f7e..cf51c24 100644
--- a/python-nitrate.spec
+++ b/python-nitrate.spec
@@ -6,7 +6,7 @@ Summary: Python API for the Nitrate test case management system
Group: Development/Languages
License: LGPLv2
-URL: http://psss.fedorapeople.org/python-nitrate/python-nitrate.html
+URL: http://psss.fedorapeople.org/python-nitrate/
Source0: http://psss.fedorapeople.org/python-nitrate/%{name}-%{version}.tar.bz2
BuildArch: noarch