[libvirt] [PATCH 2/2 v2] docs: Add some style and color to the HTML documentation
Jiri Denemark
jdenemar at redhat.com
Thu Jan 10 12:58:28 UTC 2013
On Wed, Jan 09, 2013 at 15:40:08 +0100, Claudio Bley wrote:
>
> Signed-off-by: Claudio Bley <cbley at av-test.de>
> ---
> docs/generic.css | 4 ++++
> docs/libvirt.css | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
> 2 files changed, 58 insertions(+), 2 deletions(-)
Overall it looks quite well except for few issues...
>
> diff --git a/docs/generic.css b/docs/generic.css
> index dbf7b56..1def6bf 100644
> --- a/docs/generic.css
> +++ b/docs/generic.css
> @@ -73,3 +73,7 @@ dl dd {
> margin-right: 2em;
> margin-bottom: 0.5em;
> }
> +
> +tt, pre {
> + font-family: "Ubuntu Monospace", "Consolas", "Lucida Console", monospace;
> +}
Do not do this. Default font-family for tt/pre is just good enough. If
you don't like it, change your desktop/browser settings.
> diff --git a/docs/libvirt.css b/docs/libvirt.css
> index 5123ed6..2bd9f8f 100644
> --- a/docs/libvirt.css
> +++ b/docs/libvirt.css
> @@ -184,23 +184,25 @@ div.api {
> border: 1px solid #999999;
> background: #eeeeee;
> color: black;
> + padding: 3px;
> }
>
> div.api pre {
> margin: 0px;
> border: 0px;
> background: inherit;
> + padding: inherit;
> }
>
> div.api table {
> margin: 0px;
> padding-left: 2em;
> - font-family: fixed;
> - whitespace: pre;
> + border-spacing: 0px;
> }
>
> div.api table td, div.variablelist table td {
> vertical-align: top;
> + padding-left: 1em;
> }
>
>
> @@ -412,3 +414,53 @@ table.data tbody td.n {
> background: rgb(255,220,220);
> text-align: center;
> }
> +
> +.api {
> + font-family: "Ubuntu Monospace", "Consolas", "Lucida Console", monospace;
> + line-height: 175%;
> +}
Just
font-family: monospace;
without other families and without the huge line-height which makes
reading hard.
> +
> +.api .type {
> + font-weight: bold;
> + white-space: nowrap;
> + color: darkslateblue;
> +}
> +
> +.api .keyword {
> + font-weight: bold;
> + color: #A2F;
> +}
> +
> +.api .comment {
> + color: #080;
> + margin-left: 2em;
> + position: relative;
> +}
> +
> +.api .comment:before {
> + content: ": ";
> + position: absolute;
> + left: -1.3em;
> +}
> +
> +.api .undisclosed {
> + font-style: italic;
> + letter-spacing: .3ex;
> + font-weight: bolder;
> + text-transform: uppercase;
> +}
> +
> +.api .directive {
> + color: teal;
> +}
> +
> +.api :link:hover, .api :link:focus {
> + color: blue;
> + border-color: blue;
> +}
> +
> +.api :link {
> + text-decoration: none;
> + padding-bottom: 2px;
> + border-bottom: 1px dashed grey;
> +}
Leaving just
text-decoration: none;
would be best. However, if you think links need to be more visually
distinguished, removing this whole .api :link style is more more
readable then adding dashed underlining far below the text.
Jirka
More information about the libvir-list
mailing list