ソースを参照

docs: Make documentation more stylish

Ole 10 年 前
コミット
3e7e718f7b
共有5 個のファイルを変更した247 個の追加13 個の削除を含む
  1. 1 1
      .gitignore
  2. 12 12
      Doxyfile
  3. 2 0
      docs/footer.html
  4. 20 0
      docs/header.html
  5. 212 0
      docs/stylesheet.css

+ 1 - 1
.gitignore

@@ -1,6 +1,6 @@
 examples/*.out
 tests/all
-docs/
+docs/html/
 
 *.d
 *.o

+ 12 - 12
Doxyfile

@@ -133,7 +133,7 @@ ALWAYS_DETAILED_SEC    = NO
 # operators of the base classes will not be shown.
 # The default value is: NO.
 
-INLINE_INHERITED_MEMB  = YES
+INLINE_INHERITED_MEMB  = NO
 
 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
 # before files name in the file list and in the header files. If set to NO the
@@ -525,7 +525,7 @@ HIDE_COMPOUND_REFERENCE= NO
 # the files that are included by a file in the documentation of that file.
 # The default value is: YES.
 
-SHOW_INCLUDE_FILES     = YES
+SHOW_INCLUDE_FILES     = NO
 
 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
 # grouped member an include statement to the documentation, telling the reader
@@ -654,7 +654,7 @@ SHOW_USED_FILES        = NO
 # (if specified).
 # The default value is: YES.
 
-SHOW_FILES             = YES
+SHOW_FILES             = NO
 
 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
 # page. This will remove the Namespaces entry from the Quick Index and from the
@@ -962,7 +962,7 @@ REFERENCES_LINK_SOURCE = YES
 # The default value is: YES.
 # This tag requires that the tag SOURCE_BROWSER is set to YES.
 
-SOURCE_TOOLTIPS        = YES
+SOURCE_TOOLTIPS        = NO
 
 # If the USE_HTAGS tag is set to YES then the references to source code will
 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
@@ -992,7 +992,7 @@ USE_HTAGS              = NO
 # See also: Section \class.
 # The default value is: YES.
 
-VERBATIM_HEADERS       = YES
+VERBATIM_HEADERS       = NO
 
 #---------------------------------------------------------------------------
 # Configuration options related to the alphabetical class index
@@ -1062,7 +1062,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_HEADER            =
+HTML_HEADER            = docs/header.html
 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1072,7 +1072,7 @@ HTML_HEADER            =
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            =
+HTML_FOOTER            = docs/footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1097,7 +1097,7 @@ HTML_STYLESHEET        =
 # list). For an example see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  =
+HTML_EXTRA_STYLESHEET  = docs/stylesheet.css
 
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
@@ -1971,7 +1971,7 @@ EXPAND_ONLY_PREDEF     = NO
 # The default value is: YES.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-SEARCH_INCLUDES        = YES
+SEARCH_INCLUDES        =
 
 # The INCLUDE_PATH tag can be used to specify one or more directories that
 # contain include files that are not input files but should be processed by the
@@ -2080,7 +2080,7 @@ PERL_PATH              = /usr/bin/perl
 # powerful graphs.
 # The default value is: YES.
 
-CLASS_DIAGRAMS         = YES
+CLASS_DIAGRAMS         = NO
 
 # You can define message sequence charts within doxygen comments using the \msc
 # command. Doxygen will then run the mscgen tool (see:
@@ -2207,7 +2207,7 @@ TEMPLATE_RELATIONS     = NO
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-INCLUDE_GRAPH          = YES
+INCLUDE_GRAPH          = NO
 
 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
 # set to YES then doxygen will generate a graph for each documented file showing
@@ -2216,7 +2216,7 @@ INCLUDE_GRAPH          = YES
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-INCLUDED_BY_GRAPH      = YES
+INCLUDED_BY_GRAPH      = NO
 
 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
 # dependency graph for every global function or class method.

+ 2 - 0
docs/footer.html

@@ -0,0 +1,2 @@
+	</body>
+</html>

+ 20 - 0
docs/header.html

@@ -0,0 +1,20 @@
+<!-- HTML header for doxygen 1.8.10-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+	<head>
+		<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+		<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+		<meta name="generator" content="Doxygen $doxygenversion"/>
+		<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
+		<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
+		<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
+		<script type="text/javascript" src="$relpath^jquery.js"></script>
+		<script type="text/javascript" src="$relpath^dynsections.js"></script>
+		$treeview
+		$search
+		$mathjax
+		<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+		$extrastylesheet
+	</head>
+	<body>
+		<div id="top">

+ 212 - 0
docs/stylesheet.css

@@ -0,0 +1,212 @@
+@import url("http://fonts.googleapis.com/css?family=Roboto");
+
+/*
+ * This truly is the worst CSS I have ever written.
+ * It works, though.
+ */
+
+body {
+	background: #222;
+	color: #fff;
+}
+
+.tabs, .tabs2, .tabs3 {
+	background: #333;
+}
+
+.tablist li {
+	background: transparent;
+}
+
+.tablist li a {
+	border: none;
+	background: none;
+	transition: all 500ms;
+}
+
+.tablist li:hover a {
+	background: #444;
+}
+
+.tablist li.current a {
+	background: #644;
+}
+
+.tablist li a span {
+	color: #efefef;
+	text-shadow: none;
+	font-family: Roboto;
+	font-weight: normal;
+}
+
+.tabs .tablist li a span {
+	font-size: 14px;
+}
+
+.tabs2 .tablist li a span {
+	font-size: 12px;
+}
+
+.navpath {
+	display: none;
+}
+
+.contents a:link, .contents a:visited {
+	color: #644;
+}
+
+.contents a:hover {
+	text-decoration: none;
+}
+
+.header {
+	display: none;
+}
+
+.contents .fragment {
+	padding: 5px;
+	background-color: #444;
+	border: solid 1px rgba(255, 255, 255, 0.2);
+}
+
+.contents .fragment .lineno {
+	background-color: #333;
+	border: none;
+	padding-right: 10px;
+}
+
+.contents code {
+	color: #a0a0a0;
+}
+
+.ui-resizable-handle {
+	background: none;
+	width: 0;
+	border-right: solid 1px #333;
+}
+
+#side-nav {
+	padding: 0;
+}
+
+#nav-tree {
+	background: none;
+}
+
+#nav-tree-contents {
+	margin: 0px;
+}
+
+.contents div.directory {
+	border: none;
+}
+
+.contents table.directory tbody tr {
+	background: #333;
+}
+
+.contents table.directory .entry {
+	padding: 10px;
+}
+
+.contents table.directory .entry .icona,
+.contents table.directory .entry span {
+	display: none !important;
+}
+
+.contents .groupheader {
+	color: #fff;
+	border-bottom: solid 1px #333;
+}
+
+.contents .memberdecls .memItemRight,
+.contents .memberdecls .memItemLeft,
+.contents .memberdecls .memTemplItemRight,
+.contents .memberdecls .memTemplItemLeft {
+	background: none;
+	border: none;
+	text-align: left;
+	font-family: monospace;
+	font-size: 14px;
+	font-weight: normal;
+}
+
+.contents .memberdecls .memTemplParams {
+	background: none;
+	color: #a0a0a0;
+	font-family: monospace;
+	font-size: 12px;
+}
+
+.contents .memberdecls .memSeparator {
+	border: none;
+	border-top: solid 1px #333;
+	height: 10px
+}
+
+.contents .memitem {
+	background-color: #333;
+}
+
+.contents .memitem .memproto,
+.contents .memitem .memdoc {
+	border: none;
+	background: none;
+	box-shadow: none;
+}
+
+.contents .memitem .memproto {
+	border-bottom: solid 1px #222;
+}
+
+.contents .memitem .memname {
+	font-family: monospace;
+	color: #fff;
+	text-shadow: none;
+	font-weight: normal;
+	font-size: 14px;
+}
+
+.contents .memitem .memtemplate {
+	font-family: monospace;
+	color: #fff;
+	text-shadow: none;
+	font-weight: normal;
+	font-size: 12px;
+}
+
+.contents .mlabel {
+	border: none;
+	background: none;
+	background-color: #222;
+	border-radius: 0;
+	font-family: monospace;
+	font-size: 12px;
+	color: #fff;
+	padding: 4px;
+}
+
+.contents .paramname {
+	color: #fff;
+}
+
+.inherit_header img {
+	display: none;
+}
+
+.directory .levels {
+	display: none;
+}
+
+.contents .qindex {
+	background-color: transparent;
+	border: none;
+}
+
+.contents .ah {
+	border: none;
+	background: none;
+	border-radius: 0px;
+	box-shadow: none;
+	background-color: #333;
+}