Просмотр исходного кода

Added an option to generate Lua docs with the current Polycode's site header and footer for use on the site

Ivan Safrin 12 лет назад
Родитель
Сommit
f45a2deed8

+ 1 - 0
.gitignore

@@ -130,6 +130,7 @@ Player/Build/Mac OS X/Polycode Player.xcodeproj/project.xcworkspace/xcuserdata/i
 
 /Documentation/Lua/xml/*.xml
 
+/Documentation/Lua/site_html
 /Documentation/Lua/html/*
 !/Documentation/Lua/html/css
 !/Documentation/Lua/html/images

+ 60 - 32
Documentation/Lua/scripts/make_html.py

@@ -1,36 +1,51 @@
 import os
+import sys
 from xml.dom.minidom import parse
 
+siteDocs = False
+
+if len(sys.argv) > 1:
+	if sys.argv[1] == "site":
+		siteDocs = True
+
 globalHeaderMain = ""
 
-globalHeaderMain += "<html>\n"
-globalHeaderMain += "\t<head>\n"
-globalHeaderMain += "\t\t<title>Polycode Documentation</title>\n"
-globalHeaderMain += "\t\t<link rel=\"stylesheet\" type=\"text/css\" href=\"css/docs.css\" />\n"
-globalHeaderMain += "\t\t<link href='http://fonts.googleapis.com/css?family=Roboto:400,300' rel='stylesheet' type='text/css'>\n"
-globalHeaderMain += "\t\t<script type=\"text/javascript\" src=\"js/docs.js\"></script>"
-globalHeaderMain += "\t</head>\n"
-globalHeaderMain += "\t<body>\n"
-globalHeaderMain += "\t\t<div id=\"global_header\"><a href=\"index.html\"><img border=\"0\" src=\"images/docs_header.png\"/></a></div>\n"
-globalHeaderMain += "\t\t<div id=\"content\">\n"
-
-globalHeader = ""
-globalFooter = ""
-
-globalHeader += "<html>\n"
-globalHeader += "\t<head>\n"
-globalHeader += "\t\t<title>Polycode Documentation</title>\n"
-globalHeader += "\t\t<link rel=\"stylesheet\" type=\"text/css\" href=\"../css/docs.css\" />\n"
-globalHeader += "\t\t<script type=\"text/javascript\" src=\"js/docs.js\"></script>"
-globalHeader += "\t</head>\n"
-globalHeader += "\t<body>\n"
-globalHeader += "\t\t<div id=\"global_header\"><a href=\"../index.html\"><img border=\"0\" src=\"../images/docs_header.png\"/></a></div>\n"
-globalHeader += "\t\t<div id=\"content\">\n"
-
-
-globalFooter += "\t\t</div>\n"
-globalFooter += "\t</body>\n"
-globalFooter += "\t</html>\n"
+if siteDocs == True:
+	header_f = open("site_header.html", 'r')
+	globalHeaderMain = header_f.read()
+	globalHeader = globalHeaderMain
+	footer_f = open("site_footer.html", 'r')
+	globalFooter = footer_f.read()
+	
+else:
+	globalHeaderMain += "<html>\n"
+	globalHeaderMain += "\t<head>\n"
+	globalHeaderMain += "\t\t<title>Polycode Documentation</title>\n"
+	globalHeaderMain += "\t\t<link rel=\"stylesheet\" type=\"text/css\" href=\"css/docs.css\" />\n"
+	globalHeaderMain += "\t\t<link href='http://fonts.googleapis.com/css?family=Roboto:400,300' rel='stylesheet' type='text/css'>\n"
+	globalHeaderMain += "\t\t<script type=\"text/javascript\" src=\"js/docs.js\"></script>"
+	globalHeaderMain += "\t</head>\n"
+	globalHeaderMain += "\t<body>\n"
+	globalHeaderMain += "\t\t<div id=\"global_header\"><a href=\"index.html\"><img border=\"0\" src=\"images/docs_header.png\"/></a></div>\n"
+	globalHeaderMain += "\t\t<div id=\"content\">\n"
+
+	globalHeader = ""
+	globalFooter = ""
+
+	globalHeader += "<html>\n"
+	globalHeader += "\t<head>\n"
+	globalHeader += "\t\t<title>Polycode Documentation</title>\n"
+	globalHeader += "\t\t<link rel=\"stylesheet\" type=\"text/css\" href=\"../css/docs.css\" />\n"
+	globalHeader += "\t\t<script type=\"text/javascript\" src=\"js/docs.js\"></script>"
+	globalHeader += "\t</head>\n"
+	globalHeader += "\t<body>\n"
+	globalHeader += "\t\t<div id=\"global_header\"><a href=\"../index.html\"><img border=\"0\" src=\"../images/docs_header.png\"/></a></div>\n"
+	globalHeader += "\t\t<div id=\"content\">\n"
+
+
+	globalFooter += "\t\t</div>\n"
+	globalFooter += "\t</body>\n"
+	globalFooter += "\t</html>\n"
 
 def createMethods(className, item, static):
 
@@ -180,19 +195,28 @@ def makeHTML(fileName, moduleName):
 	classList += "\t\t\t</div>\n"
 	classList += "\n"
 
-	directory = "../html/%s" % (moduleName)
+	if siteDocs == True:
+		directory = "../site_html/%s" % (moduleName)
+	else:
+		directory = "../html/%s" % (moduleName)
 	if not os.path.exists(directory):
 		os.makedirs(directory)	
 
 	html = globalHeader
 	html += classList
 	html += globalFooter
-	f = open("../html/%s/index.html" % (moduleName), 'w')
+	if siteDocs == True:
+		f = open("../site_html/%s/index.html" % (moduleName), 'w')
+	else:
+		f = open("../html/%s/index.html" % (moduleName), 'w')
 	f.write(html)
 	f.close()
 
 	for item in dom.documentElement.getElementsByTagName('class'):
-		f = open("../html/%s/%s.html" % (moduleName, item.attributes["name"].value), 'w')
+		if siteDocs == True:
+			f = open("../site_html/%s/%s.html" % (moduleName, item.attributes["name"].value), 'w')
+		else:
+			f = open("../html/%s/%s.html" % (moduleName, item.attributes["name"].value), 'w')
 		html = makePage(item, classList, classListPlain, moduleName)
 		f.write(html)
 		f.close()
@@ -211,7 +235,11 @@ for fname in dirList:
 
 indexhtml += "\t</div>\n"
 
-f = open("../html/index.html", 'w')
+if siteDocs == True:
+	f = open("../site_html/index.html", 'w')
+else:
+	f = open("../html/index.html", 'w')
+
 f.write(indexhtml)
 f.close()
 indexhtml += globalFooter

+ 8 - 0
Documentation/Lua/scripts/site_footer.html

@@ -0,0 +1,8 @@
+		</div>
+		</div>
+			<div id="footer">
+				Copyright Polycode Framework, Ivan Safrin, Polycode team, 2013
+			</div>
+		</div>
+	</body>
+</html>

+ 39 - 0
Documentation/Lua/scripts/site_header.html

@@ -0,0 +1,39 @@
+<html>
+	<head>	
+		<title>Polycode</title>
+		 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+		<meta name="description" content="Polycode is a free, open-source, cross-platform framework for creative code. "/>
+		<meta name="keywords" content="2d,3d,opengl,framework,game,engine,creative,code,sound" />
+		<link href='http://fonts.googleapis.com/css?family=Roboto:400,300' rel='stylesheet' type='text/css'>
+		<link href="/css/prettify.css" type="text/css" rel="stylesheet" />
+		<link href="/css/lua_docs.css" type="text/css" rel="stylesheet" />
+		<script type="text/javascript" src="/js/prettify.js"></script>
+		<link rel="image_src" type="image/jpeg" href="http://www.polycode.org/img/icon-facebook.gif" />
+		<link rel="stylesheet" type="text/css" media="screen" href="/css/main.css"/>
+<script type="text/javascript">
+  var _gaq = _gaq || [];
+  _gaq.push(['_setAccount', 'UA-309912-5']);
+  _gaq.push(['_trackPageview']);
+
+  (function() {
+    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+  })();
+
+</script>
+	</head>
+	<body onLoad="prettyPrint()">
+		<div id="content_pane">
+		<div id="nav">
+			<div id="nav_logo"><a href="/"><img src="/img/toplogo.png"/></a></div>
+			<div id="nav_menu">
+				<span class="menu_item"><a href="/features">FEATURES</a></span>
+				<span class="menu_item"><a href="/gallery">GALLERY</a></span>
+				<span class="menu_item"><a href="/download">DOWNLOAD</a></span>
+				<span class="menu_item"><a href="/learn">LEARN</a></span>
+				<span class="menu_item"><a href="/community">COMMUNITY</a></span>
+			</div>
+		</div>
+		<div id="page_content_main">
+		<div id="lua_docs_content">