aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Christie2013-03-15 13:41:22 +0000
committerTom Christie2013-03-15 13:41:22 +0000
commit22a389d0ba4dd5ac7b4fa3839491ec2708bbe7df (patch)
tree8b392f465a563210fcba0c5d86cf760c8e11b429
parentda76bd704726830b0b76aabe7aef91b2deb72b02 (diff)
downloaddjango-rest-framework-22a389d0ba4dd5ac7b4fa3839491ec2708bbe7df.tar.bz2
Better titles & descriptions
-rw-r--r--docs/template.html6
-rwxr-xr-xmkdocs.py12
2 files changed, 15 insertions, 3 deletions
diff --git a/docs/template.html b/docs/template.html
index 08620882..3e0f29aa 100644
--- a/docs/template.html
+++ b/docs/template.html
@@ -2,11 +2,11 @@
<html lang="en">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
- <title>Django REST framework - APIs made easy.</title>
+ <title>{{ title }}</title>
<link href="{{ base_url }}/img/favicon.ico" rel="icon" type="image/x-icon">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <meta name="description" content="">
- <meta name="author" content="">
+ <meta name="description" content="{{ description }}">
+ <meta name="author" content="Tom Christie">
<!-- Le styles -->
<link href="{{ base_url }}/css/prettify.css" rel="stylesheet">
diff --git a/mkdocs.py b/mkdocs.py
index 2918f7d3..f6c89e04 100755
--- a/mkdocs.py
+++ b/mkdocs.py
@@ -57,24 +57,36 @@ for (dirpath, dirnames, filenames) in os.walk(docs_dir):
toc = ''
text = open(path, 'r').read().decode('utf-8')
+ main_title = None
+ description = 'Django, API, REST'
for line in text.splitlines():
if line.startswith('# '):
title = line[2:].strip()
template = main_header
+ description = description + ', ' + title
elif line.startswith('## '):
title = line[3:].strip()
template = sub_header
else:
continue
+ if not main_title:
+ main_title = title
anchor = title.lower().replace(' ', '-').replace(':-', '-').replace("'", '').replace('?', '').replace('.', '')
template = template.replace('{{ title }}', title)
template = template.replace('{{ anchor }}', anchor)
toc += template + '\n'
+ if filename == 'index.md':
+ main_title = 'Django REST framework - APIs made easy'
+ else:
+ main_title = 'Django REST framework - ' + main_title
+
content = markdown.markdown(text, ['headerid'])
output = page.replace('{{ content }}', content).replace('{{ toc }}', toc).replace('{{ base_url }}', base_url).replace('{{ suffix }}', suffix).replace('{{ index }}', index)
+ output = output.replace('{{ title }}', main_title)
+ output = output.replace('{{ description }}', description)
output = output.replace('{{ page_id }}', filename[:-3])
output = re.sub(r'a href="([^"]*)\.md"', r'a href="\1%s"' % suffix, output)
output = re.sub(r'<pre><code>:::bash', r'<pre class="prettyprint lang-bsh">', output)