encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-02-03 05:04:31 +03:00
Code Issues Packages Projects Releases Wiki Activity

Drop .html suffixes in docs

Browse Source
This commit is contained in:
Tom Christie 2013-11-18 16:10:14 +00:00
parent 4ddbeb1634
commit 20325cce18
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/template.html
View File

@ -4,6 +4,7 @@
<meta charset="utf-8"> <meta charset="utf-8">
<title>{{ title }}</title> <title>{{ title }}</title>
<link href="{{ base_url }}/img/favicon.ico" rel="icon" type="image/x-icon"> <link href="{{ base_url }}/img/favicon.ico" rel="icon" type="image/x-icon">
<link rel="canonical" href="{{ canonical_url }}"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="{{ description }}"> <meta name="description" content="{{ description }}">
<meta name="author" content="Tom Christie"> <meta name="author" content="Tom Christie">

9
mkdocs.py
View File

@ -19,7 +19,7 @@ if local:
index = 'index.html' index = 'index.html'
else: else:
base_url = 'http://django-rest-framework.org' base_url = 'http://django-rest-framework.org'
suffix = '.html' suffix = ''
index = '' index = ''
@ -90,7 +90,10 @@ for idx in range(len(path_list)):
path = path_list[idx] path = path_list[idx]
rel = '../' * path.count('/') rel = '../' * path.count('/')
if idx > 0: if idx == 1 and not local:
# Link back to '/', not '/index'
prev_url_map[path] = '/'
elif idx > 0:
prev_url_map[path] = rel + path_list[idx - 1][:-3] + suffix prev_url_map[path] = rel + path_list[idx - 1][:-3] + suffix
if idx < len(path_list) - 1: if idx < len(path_list) - 1:
@ -143,6 +146,7 @@ for (dirpath, dirnames, filenames) in os.walk(docs_dir):
else: else:
main_title = 'Django REST framework - ' + main_title main_title = 'Django REST framework - ' + main_title
canonical_url = base_url + '/' + relative_path[:-3] + suffix
prev_url = prev_url_map.get(relative_path) prev_url = prev_url_map.get(relative_path)
next_url = next_url_map.get(relative_path) next_url = next_url_map.get(relative_path)
@ -152,6 +156,7 @@ for (dirpath, dirnames, filenames) in os.walk(docs_dir):
output = output.replace('{{ title }}', main_title) output = output.replace('{{ title }}', main_title)
output = output.replace('{{ description }}', description) output = output.replace('{{ description }}', description)
output = output.replace('{{ page_id }}', filename[:-3]) output = output.replace('{{ page_id }}', filename[:-3])
output = output.replace('{{ canonical_url }}', canonical_url)
if prev_url: if prev_url:
output = output.replace('{{ prev_url }}', prev_url) output = output.replace('{{ prev_url }}', prev_url)