Get rid of all Sphinx warnings

This commit is contained in:
Danilo Bargen 2013-07-06 13:54:48 +02:00
parent 771af88877
commit 2282f9681d
5 changed files with 10 additions and 7 deletions

1
.gitignore vendored
View file

@ -42,7 +42,6 @@ coverage
# Sphinx
docs/_build
docs/_static
# Launchpad
lp-cache

1
docs/_static/README vendored Normal file
View file

@ -0,0 +1 @@
Put static files for Sphinx in here.

View file

@ -44,7 +44,8 @@ sys.path.append(ext_path)
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['djangodocs', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
extensions = ['djangodocs', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
'sphinx.ext.todo']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

View file

@ -1,9 +1,11 @@
Built-In Views
===============
Each of these views contains the list of context variables that are included in their templates.
Each of these views contains the list of context variables that are included in
their templates.
TODO: Provide a list of template context variables for each view per GitHub issue in view class' top-level docstring `#220`_
TODO: Provide a list of template context variables for each view per GitHub
issue in view class' top-level docstring `#220`_
.. _`#220`: https://github.com/twoscoops/django-admin2/issues/220

View file

@ -138,12 +138,12 @@ In the settings module, place the theme right after djadmin2 (change the highlig
)
########### END DJANGO-ADMIN2 CONFIGURATION
.. TODO:: Have someone besides pydanny test this!
.. todo:: Have someone besides pydanny test this!
Views and their Templates
-------------------------
See :ref:`Built-In Views`
See doc:`built-in-views`
Available Themes
@ -156,4 +156,4 @@ If you'd like to experiment with UI design that differs from the original Django
Future
------
Keep in mind that this project is an experiment just to get our ideas down. We are looking at other similar projects to see if we can merge or borrow things.
Keep in mind that this project is an experiment just to get our ideas down. We are looking at other similar projects to see if we can merge or borrow things.