diff options
| author | tom christie tom@tomchristie.com | 2011-02-01 19:55:57 +0000 |
|---|---|---|
| committer | tom christie tom@tomchristie.com | 2011-02-01 19:55:57 +0000 |
| commit | 478dc2d0ce1c350dab7de28fbbdad5188f2e3bb5 (patch) | |
| tree | 2f43fb236fa18b745c34cf3a7dfe20be6a676f4b /docs | |
| parent | 98b5b2abd8af88271b9f002c4cff878949c08957 (diff) | |
| download | django-rest-framework-478dc2d0ce1c350dab7de28fbbdad5188f2e3bb5.tar.bz2 | |
Fix up doc title & desc, fix repo link
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 20 | ||||
| -rw-r--r-- | docs/index.rst | 7 | ||||
| -rw-r--r-- | docs/templates/layout.html | 13 |
3 files changed, 28 insertions, 12 deletions
diff --git a/docs/conf.py b/docs/conf.py index 3689a636..9a81e1b1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,7 +35,7 @@ setup_environ(settings) extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. -templates_path = [] +templates_path = ['templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -111,7 +111,7 @@ html_theme = 'default' # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". -#html_title = None +html_title = "Django REST Framework" # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None @@ -172,7 +172,7 @@ html_static_path = [] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'restfulloggingdoc' +#htmlhelp_basename = '' # -- Options for LaTeX output -------------------------------------------------- @@ -185,10 +185,9 @@ htmlhelp_basename = 'restfulloggingdoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'restfullogging.tex', u'restful logging Documentation', - u'tom c', 'manual'), -] +#latex_documents = [ +# (), +#] # The name of an image file (relative to this directory) to place at the top of # the title page. @@ -217,7 +216,6 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'restfullogging', u'restful logging Documentation', - [u'tom c'], 1) -] +#man_pages = [ +# () +#] diff --git a/docs/index.rst b/docs/index.rst index 474788c0..10f87a48 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,8 @@ +.. meta:: + :description: A lightweight REST framework for Django. + :keywords: django, python, REST, RESTful + + Django REST framework ===================== @@ -29,7 +34,7 @@ Installation & Setup The django-rest-framework project is hosted as a `mercurial repository on bitbucket <https://bitbucket.org/tomchristie/django-rest-framework>`_. To get a local copy of the repository use mercurial:: - hg clone https://tomchristie@bitbucket.org/tomchristie/django-rest-framework + hg clone https://bitbucket.org/tomchristie/django-rest-framework To add django-rest-framework to a django project: diff --git a/docs/templates/layout.html b/docs/templates/layout.html new file mode 100644 index 00000000..681266cc --- /dev/null +++ b/docs/templates/layout.html @@ -0,0 +1,13 @@ +{% extends "!layout.html" %} + +{%- if not embedded and docstitle %} + {%- set titleprefix = docstitle|e + " - "|safe %} +{%- else %} + {%- set titleprefix = "" %} +{%- endif %} + +{% block htmltitle %}<title>{% if pagename == 'index' %}Django REST Framework{% else %}{{ titleprefix }}{{ title|striptags|e }}{% endif %}</title>{% endblock %} +{% block extrahead %} +{{ super() }} +{% endblock %} + |
