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

Fix up doc title & desc, fix repo link

Browse Source
This commit is contained in:
tom christie tom@tomchristie.com 2011-02-01 19:55:57 +00:00
parent 98b5b2abd8
commit 478dc2d0ce
5 changed files with 30 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.hgignore
View File

@ -4,7 +4,7 @@ syntax: glob
*.db *.db
*~ *~
env env
docs-build docs/build
html html
examples/media/pygments/* examples/media/pygments/*
examples/media/objectstore/* examples/media/objectstore/*

2
README.txt
View File

@ -9,7 +9,7 @@ pip install -r requirements.txt
# To build the documentation... # To build the documentation...
pip install -r docs/requirements.txt pip install -r docs/requirements.txt
sphinx-build -c docs -b html -d docs-build docs html sphinx-build -c docs -b html -d docs/build docs html
# To run the examples... # To run the examples...

20
docs/conf.py
View File

@ -35,7 +35,7 @@ setup_environ(settings)
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] 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. # Add any paths that contain templates here, relative to this directory.
templates_path = [] templates_path = ['templates']
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'
@ -111,7 +111,7 @@ html_theme = 'default'
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<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. # A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None #html_short_title = None
@ -172,7 +172,7 @@ html_static_path = []
#html_file_suffix = None #html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'restfulloggingdoc' #htmlhelp_basename = ''
# -- Options for LaTeX output -------------------------------------------------- # -- Options for LaTeX output --------------------------------------------------
@ -185,10 +185,9 @@ htmlhelp_basename = 'restfulloggingdoc'
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ #latex_documents = [
('index', 'restfullogging.tex', u'restful logging Documentation', # (),
u'tom c', 'manual'), #]
]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
# the title page. # the title page.
@ -217,7 +216,6 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ #man_pages = [
('index', 'restfullogging', u'restful logging Documentation', # ()
[u'tom c'], 1) #]
]

7
docs/index.rst
View File

@ -1,3 +1,8 @@
.. meta::
:description: A lightweight REST framework for Django.
:keywords: django, python, REST, RESTful
Django REST framework 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>`_. 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:: 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: To add django-rest-framework to a django project:

13
docs/templates/layout.html vendored Normal file
View File

@ -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 %}