From f5d9caefed343e9d6cf80ff68eda4d9b9ee749a3 Mon Sep 17 00:00:00 2001 From: Mrt134 Date: Thu, 1 Sep 2016 13:37:37 -0400 Subject: [PATCH] Update API reference, client, and server handbooks - Edited link colors to be a stronger blue/red color. - Altered hover role for links to add underlining to the link texts. - Restyled roles - Unified padding boxes and colors (exception: :guilabel: uses a different color). All roles should now have the same height padding, which has been reduced as well. - Role colors have all been lightened to avoid being distracting or making contained text hard to read. - Removed bold from :menuselection:. - :command: now renders as a monospace font. - Restyled admonitions - Darkened text inside admonition boxes. - Rounded border elements around boxes. - Reworked borders to be smaller and darker in color. - Fixed figure captions to be smaller and fit better with the surrounding text. - Restyled tables - Table captions now have the same style as figure captions. - Altered color for headers - Added hover themeing for tables: mousing over a row or header title will change its color. --- docs/api_reference/conf.py | 4 +- .../trueos_style/static/css/trueos_style.css | 90 ++++++++++++------- .../trueos_style/static/css/trueos_style.css | 90 ++++++++++++------- docs/client_handbook/conf.py | 2 +- docs/server_handbook/conf.py | 4 +- .../trueos_style/static/css/trueos_style.css | 90 ++++++++++++------- 6 files changed, 179 insertions(+), 101 deletions(-) diff --git a/docs/api_reference/conf.py b/docs/api_reference/conf.py index a203fc4..83fa2e7 100644 --- a/docs/api_reference/conf.py +++ b/docs/api_reference/conf.py @@ -181,10 +181,10 @@ html_logo = 'sysadm_circle_red.png' #html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True diff --git a/docs/api_reference/themes/trueos_style/static/css/trueos_style.css b/docs/api_reference/themes/trueos_style/static/css/trueos_style.css index cab5dae..945a93b 100644 --- a/docs/api_reference/themes/trueos_style/static/css/trueos_style.css +++ b/docs/api_reference/themes/trueos_style/static/css/trueos_style.css @@ -1938,15 +1938,18 @@ input[type="checkbox"][disabled] { border-spacing: 0; empty-cells: show; margin-bottom: 24px; -line-height: 19px; + line-height: 19px; } .wy-table caption, .rst-content table.docutils caption, .rst-content table.field-list caption { - color: #000; - font: italic 85%/1 arial, sans-serif; - padding: 1em 0; - text-align: center + color: #404040; + font-family: "Roboto Slab", "ff-tisa-web-pro", "Georgia", Arial, sans-serif; + font-size: 100%; + font-weight: 700; + padding: .2em; + text-align: left; + caption-side: bottom } .wy-table td, .rst-content table.docutils td, @@ -1957,7 +1960,7 @@ line-height: 19px; font-size: 90%; margin: 0; overflow: visible; - padding: 8px 16px + padding: 8px 16px; } .wy-table td:first-child, .rst-content table.docutils td:first-child, @@ -2021,9 +2024,23 @@ line-height: 19px; font-size: 80% } .wy-table-odd td, -.wy-table-striped tr:nth-child(2n-1) td, -.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td { - background-color: #f3f6f6 +.wy-table-striped tr:nth-child(odd) td, +.rst-content table.docutils:not(.field-list) tr:nth-child(odd) td { + background-color: #f3f6f6; +} +.wy-table-odd td, +.wy-table-striped tr:nth-child(odd):hover td, +.rst-content table.docutils:not(.field-list) tr:nth-child(odd):hover td { + background-color: #f2d8bb +} +.wy-table-even td, +.wy-table-striped tr:nth-child(even):hover td, +.rst-content table.docutils:not(.field-list) tr:nth-child(even):hover td { + background-color: #f2d8bb +} +.wy-table tr, +.rst-content table.docutils th:hover{ + background-color: #f2d8bb } .wy-table-backed { background-color: #f3f6f6 @@ -2074,15 +2091,16 @@ line-height: 19px; white-space: inherit } a { - color: #2980B9; + color: #2c3fbd; text-decoration: none; cursor: pointer } a:hover { - color: #3091d1 + color: #4653a3; + text-decoration: underline } a:visited { - color: #9B59B6 + color: #c73030 } html { height: 100%; @@ -2167,17 +2185,17 @@ p { margin-bottom: 24px } h1 { - font-size: 175% + font-size: 100% } h2, .rst-content p.caption { - font-size: 150% + font-size: 100% } h3 { - font-size: 125% + font-size: 100% } h4 { - font-size: 115% + font-size: 100% } h5 { font-size: 110% @@ -3678,15 +3696,15 @@ code.menuselection, .file, .guilabel, .menuselection{ - background-color: #D5DDE2; /* saturate from ecf0f3 to be more visible/blue on screen. */ + background-color: #e6ede9; /* saturate from ecf0f3 to be more visible/blue on screen. */ display: inline; font-family:'Inconsolata', monospace; font-size: 95%; - padding-right: 3px; - padding-left: 3px; - padding-top: 3px; - padding-bottom: 3px; - border-radius: 3px; + padding-right: 1px; + padding-left: 1px; + padding-top: 1px; + padding-bottom: 1px; + border-radius: 4px; overflow: hidden; } code.kbd, .kbd { @@ -3703,9 +3721,8 @@ code.guilabel, .guilabel { text-transform: none } code.menuselection, .menuselection { - background-color: #e6e6ed; + background-color: #e8ede6; color: inherit; - font-weight: 600; border: hidden; font-size: 98% } @@ -3791,7 +3808,7 @@ th.spiffy_span { } .docutils th, .spiffy_table th { - background-color: LemonChiffon; + background-color: #bbeaf2; font-weight: 700; text-align: center; border-color: darkgray; @@ -3838,7 +3855,6 @@ th { table.docutils { border-collapse: collapse; } - /*"""""""""""""""""""""""""""""""""""""""""""""""* | spiffy_table adjusted for rst/RtD (END) | *"""""""""""""""""""""""""""""""""""""""""""""""*/ @@ -3848,24 +3864,34 @@ table.docutils { | textboxes adjusted for rst/RtD (BEGIN) | *"""""""""""""""""""""""""""""""""""""""""""*/ .rst-content .danger, .rdangerbox { -border:solid #bababa; -background: #edbeb6 +border: 2px solid #8a8988; +border-radius: 5px; +background: #edbeb6; +color: #030303 } .rst-content .warning, .rwarningbox { -border:solid #bababa; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rst-content .note, .rnotebox { -border:solid #BABABA; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rst-content .important, .rimportantbox{ -border:solid #bababa; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rst-content .tip, .rtipbox{ -border:solid #bababa; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rversionbox { diff --git a/docs/client_handbook/_static/trueos_style/static/css/trueos_style.css b/docs/client_handbook/_static/trueos_style/static/css/trueos_style.css index cab5dae..945a93b 100644 --- a/docs/client_handbook/_static/trueos_style/static/css/trueos_style.css +++ b/docs/client_handbook/_static/trueos_style/static/css/trueos_style.css @@ -1938,15 +1938,18 @@ input[type="checkbox"][disabled] { border-spacing: 0; empty-cells: show; margin-bottom: 24px; -line-height: 19px; + line-height: 19px; } .wy-table caption, .rst-content table.docutils caption, .rst-content table.field-list caption { - color: #000; - font: italic 85%/1 arial, sans-serif; - padding: 1em 0; - text-align: center + color: #404040; + font-family: "Roboto Slab", "ff-tisa-web-pro", "Georgia", Arial, sans-serif; + font-size: 100%; + font-weight: 700; + padding: .2em; + text-align: left; + caption-side: bottom } .wy-table td, .rst-content table.docutils td, @@ -1957,7 +1960,7 @@ line-height: 19px; font-size: 90%; margin: 0; overflow: visible; - padding: 8px 16px + padding: 8px 16px; } .wy-table td:first-child, .rst-content table.docutils td:first-child, @@ -2021,9 +2024,23 @@ line-height: 19px; font-size: 80% } .wy-table-odd td, -.wy-table-striped tr:nth-child(2n-1) td, -.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td { - background-color: #f3f6f6 +.wy-table-striped tr:nth-child(odd) td, +.rst-content table.docutils:not(.field-list) tr:nth-child(odd) td { + background-color: #f3f6f6; +} +.wy-table-odd td, +.wy-table-striped tr:nth-child(odd):hover td, +.rst-content table.docutils:not(.field-list) tr:nth-child(odd):hover td { + background-color: #f2d8bb +} +.wy-table-even td, +.wy-table-striped tr:nth-child(even):hover td, +.rst-content table.docutils:not(.field-list) tr:nth-child(even):hover td { + background-color: #f2d8bb +} +.wy-table tr, +.rst-content table.docutils th:hover{ + background-color: #f2d8bb } .wy-table-backed { background-color: #f3f6f6 @@ -2074,15 +2091,16 @@ line-height: 19px; white-space: inherit } a { - color: #2980B9; + color: #2c3fbd; text-decoration: none; cursor: pointer } a:hover { - color: #3091d1 + color: #4653a3; + text-decoration: underline } a:visited { - color: #9B59B6 + color: #c73030 } html { height: 100%; @@ -2167,17 +2185,17 @@ p { margin-bottom: 24px } h1 { - font-size: 175% + font-size: 100% } h2, .rst-content p.caption { - font-size: 150% + font-size: 100% } h3 { - font-size: 125% + font-size: 100% } h4 { - font-size: 115% + font-size: 100% } h5 { font-size: 110% @@ -3678,15 +3696,15 @@ code.menuselection, .file, .guilabel, .menuselection{ - background-color: #D5DDE2; /* saturate from ecf0f3 to be more visible/blue on screen. */ + background-color: #e6ede9; /* saturate from ecf0f3 to be more visible/blue on screen. */ display: inline; font-family:'Inconsolata', monospace; font-size: 95%; - padding-right: 3px; - padding-left: 3px; - padding-top: 3px; - padding-bottom: 3px; - border-radius: 3px; + padding-right: 1px; + padding-left: 1px; + padding-top: 1px; + padding-bottom: 1px; + border-radius: 4px; overflow: hidden; } code.kbd, .kbd { @@ -3703,9 +3721,8 @@ code.guilabel, .guilabel { text-transform: none } code.menuselection, .menuselection { - background-color: #e6e6ed; + background-color: #e8ede6; color: inherit; - font-weight: 600; border: hidden; font-size: 98% } @@ -3791,7 +3808,7 @@ th.spiffy_span { } .docutils th, .spiffy_table th { - background-color: LemonChiffon; + background-color: #bbeaf2; font-weight: 700; text-align: center; border-color: darkgray; @@ -3838,7 +3855,6 @@ th { table.docutils { border-collapse: collapse; } - /*"""""""""""""""""""""""""""""""""""""""""""""""* | spiffy_table adjusted for rst/RtD (END) | *"""""""""""""""""""""""""""""""""""""""""""""""*/ @@ -3848,24 +3864,34 @@ table.docutils { | textboxes adjusted for rst/RtD (BEGIN) | *"""""""""""""""""""""""""""""""""""""""""""*/ .rst-content .danger, .rdangerbox { -border:solid #bababa; -background: #edbeb6 +border: 2px solid #8a8988; +border-radius: 5px; +background: #edbeb6; +color: #030303 } .rst-content .warning, .rwarningbox { -border:solid #bababa; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rst-content .note, .rnotebox { -border:solid #BABABA; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rst-content .important, .rimportantbox{ -border:solid #bababa; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rst-content .tip, .rtipbox{ -border:solid #bababa; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rversionbox { diff --git a/docs/client_handbook/conf.py b/docs/client_handbook/conf.py index 75efc52..e0863ba 100644 --- a/docs/client_handbook/conf.py +++ b/docs/client_handbook/conf.py @@ -231,7 +231,7 @@ html_static_path = ['_static'] # If true, links to the reST sources are added to the pages. # -# html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # diff --git a/docs/server_handbook/conf.py b/docs/server_handbook/conf.py index 38c8973..d406273 100644 --- a/docs/server_handbook/conf.py +++ b/docs/server_handbook/conf.py @@ -181,13 +181,13 @@ html_logo = 'sysadm_circle_red.png' #html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -html_show_copyright = False +html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the diff --git a/docs/server_handbook/themes/trueos_style/static/css/trueos_style.css b/docs/server_handbook/themes/trueos_style/static/css/trueos_style.css index cab5dae..945a93b 100644 --- a/docs/server_handbook/themes/trueos_style/static/css/trueos_style.css +++ b/docs/server_handbook/themes/trueos_style/static/css/trueos_style.css @@ -1938,15 +1938,18 @@ input[type="checkbox"][disabled] { border-spacing: 0; empty-cells: show; margin-bottom: 24px; -line-height: 19px; + line-height: 19px; } .wy-table caption, .rst-content table.docutils caption, .rst-content table.field-list caption { - color: #000; - font: italic 85%/1 arial, sans-serif; - padding: 1em 0; - text-align: center + color: #404040; + font-family: "Roboto Slab", "ff-tisa-web-pro", "Georgia", Arial, sans-serif; + font-size: 100%; + font-weight: 700; + padding: .2em; + text-align: left; + caption-side: bottom } .wy-table td, .rst-content table.docutils td, @@ -1957,7 +1960,7 @@ line-height: 19px; font-size: 90%; margin: 0; overflow: visible; - padding: 8px 16px + padding: 8px 16px; } .wy-table td:first-child, .rst-content table.docutils td:first-child, @@ -2021,9 +2024,23 @@ line-height: 19px; font-size: 80% } .wy-table-odd td, -.wy-table-striped tr:nth-child(2n-1) td, -.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td { - background-color: #f3f6f6 +.wy-table-striped tr:nth-child(odd) td, +.rst-content table.docutils:not(.field-list) tr:nth-child(odd) td { + background-color: #f3f6f6; +} +.wy-table-odd td, +.wy-table-striped tr:nth-child(odd):hover td, +.rst-content table.docutils:not(.field-list) tr:nth-child(odd):hover td { + background-color: #f2d8bb +} +.wy-table-even td, +.wy-table-striped tr:nth-child(even):hover td, +.rst-content table.docutils:not(.field-list) tr:nth-child(even):hover td { + background-color: #f2d8bb +} +.wy-table tr, +.rst-content table.docutils th:hover{ + background-color: #f2d8bb } .wy-table-backed { background-color: #f3f6f6 @@ -2074,15 +2091,16 @@ line-height: 19px; white-space: inherit } a { - color: #2980B9; + color: #2c3fbd; text-decoration: none; cursor: pointer } a:hover { - color: #3091d1 + color: #4653a3; + text-decoration: underline } a:visited { - color: #9B59B6 + color: #c73030 } html { height: 100%; @@ -2167,17 +2185,17 @@ p { margin-bottom: 24px } h1 { - font-size: 175% + font-size: 100% } h2, .rst-content p.caption { - font-size: 150% + font-size: 100% } h3 { - font-size: 125% + font-size: 100% } h4 { - font-size: 115% + font-size: 100% } h5 { font-size: 110% @@ -3678,15 +3696,15 @@ code.menuselection, .file, .guilabel, .menuselection{ - background-color: #D5DDE2; /* saturate from ecf0f3 to be more visible/blue on screen. */ + background-color: #e6ede9; /* saturate from ecf0f3 to be more visible/blue on screen. */ display: inline; font-family:'Inconsolata', monospace; font-size: 95%; - padding-right: 3px; - padding-left: 3px; - padding-top: 3px; - padding-bottom: 3px; - border-radius: 3px; + padding-right: 1px; + padding-left: 1px; + padding-top: 1px; + padding-bottom: 1px; + border-radius: 4px; overflow: hidden; } code.kbd, .kbd { @@ -3703,9 +3721,8 @@ code.guilabel, .guilabel { text-transform: none } code.menuselection, .menuselection { - background-color: #e6e6ed; + background-color: #e8ede6; color: inherit; - font-weight: 600; border: hidden; font-size: 98% } @@ -3791,7 +3808,7 @@ th.spiffy_span { } .docutils th, .spiffy_table th { - background-color: LemonChiffon; + background-color: #bbeaf2; font-weight: 700; text-align: center; border-color: darkgray; @@ -3838,7 +3855,6 @@ th { table.docutils { border-collapse: collapse; } - /*"""""""""""""""""""""""""""""""""""""""""""""""* | spiffy_table adjusted for rst/RtD (END) | *"""""""""""""""""""""""""""""""""""""""""""""""*/ @@ -3848,24 +3864,34 @@ table.docutils { | textboxes adjusted for rst/RtD (BEGIN) | *"""""""""""""""""""""""""""""""""""""""""""*/ .rst-content .danger, .rdangerbox { -border:solid #bababa; -background: #edbeb6 +border: 2px solid #8a8988; +border-radius: 5px; +background: #edbeb6; +color: #030303 } .rst-content .warning, .rwarningbox { -border:solid #bababa; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rst-content .note, .rnotebox { -border:solid #BABABA; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rst-content .important, .rimportantbox{ -border:solid #bababa; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rst-content .tip, .rtipbox{ -border:solid #bababa; +border: 2px solid #8a8988; +border-radius: 5px; +color: #030303 } .rversionbox {