MTSR/minetest_modding_book
4
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Add more anchor links in lua_api.html

Browse Source
This commit is contained in:
rubenwardy 2015-11-22 16:41:52 +00:00
parent ecd704c0c2
commit 4788098676
3 changed files with 1081 additions and 1026 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2038
lua_api.html
View File

File diff suppressed because it is too large Load Diff

8
static/style.scss
View File

@ -137,11 +137,15 @@ code {
vertical-align: middle;
}
.header-link, .anchor {
text-decoration: none;
color: #bbb;
padding: 0 10px 0 0;
}
.header-link {
position: absolute;
right: 10px;
text-decoration: none;
color: #bbb;
}
.header-link:hover {

61
update_lua_api.py
View File

@ -1,5 +1,26 @@
import markdown, urllib2, datetime
import markdown, urllib2, datetime, re, string
from bs4 import BeautifulSoup
def get_key(index, li, title):
title = title.replace(" ", "-")
title = title.replace(" ", "-")
title = title.replace(" ", "-")
#title = re.sub(r'\([^)]*\)', '', title)
title = pattern.sub('', title)
if title == "":
return None
i = 0
while True:
key = title
if i > 0:
key = key + "_" + str(i)
i = i + 1
try:
existing = index[key]
except KeyError:
return key
#
# Downloading lua_api.txt
@ -10,14 +31,12 @@ url = "https://raw.githubusercontent.com/minetest/minetest/master/doc/lua_api.tx
text = urllib2.urlopen(url).read()
print("Pre-processing...")
print("Pre-generation replacements...")
header = """Minetest Lua Modding API Reference 0.4.13
========================================="""
text = text.replace(header, "")
#
# Generating HTML
#
@ -25,7 +44,7 @@ print("Generating HTML...")
md = markdown.Markdown(extensions=['markdown.extensions.toc'])
html = md.convert(text)
print("Post-processing...")
print("Post-generation replacements...")
links = """<ul>
<li>More information at <a href="http://www.minetest.net/">http://www.minetest.net/</a></li>
<li>Developer Wiki: <a href="http://dev.minetest.net/">http://dev.minetest.net/</a></li>
@ -39,6 +58,38 @@ links += ".<br />See <a href=\"https://github.com/minetest/minetest/blob/master/
links += "<br />Generated using <a href=\"https://github.com/rubenwardy/minetest_modding_book/blob/gh-pages/update_lua_api.py\">a Python script</a>."
html = html.replace("<h2 id=\"programming-in-lua\">", links + "<h2 id=\"programming-in-lua\">")
print("Parsing HTML...")
soup = BeautifulSoup(html, 'html.parser')
pattern = re.compile('[\W]+')
lis = soup.find_all("li")
index = {}
# Build index of anchors
headings = soup.find_all({"h1", "h2", "h3", "h4", "h5", "h6"})
for tag in headings:
if tag.has_attr("id"):
index[tag["id"]] = True
if tag.has_attr("name"):
index[tag["name"]] = True
# Add anchors to <li>s containing <code>
for li in lis:
code = li.find_all('code')
if len(code) > 0:
key = get_key(index, li, code[0].string)
if key is not None:
index[key] = True
#print("Created " + key)
new_tag = soup.new_tag('a', href="#" + key)
new_tag['class'] = "anchor"
new_tag['name'] = key
new_tag.string = "#"
li.insert(0, new_tag)
html = str(soup)
#
# Writing to file
#