diff --git a/.gitignore b/.gitignore index 85316c2..6911cad 100644 --- a/.gitignore +++ b/.gitignore @@ -42,7 +42,6 @@ coverage # Sphinx docs/_build -docs/_static # Launchpad lp-cache diff --git a/docs/_static/README b/docs/_static/README new file mode 100644 index 0000000..7fd9945 --- /dev/null +++ b/docs/_static/README @@ -0,0 +1 @@ +Put static files for Sphinx in here. diff --git a/docs/conf.py b/docs/conf.py index 4c2e76e..dfe4a65 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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'] diff --git a/docs/ref/built-in-views.rst b/docs/ref/built-in-views.rst index 0880299..84c633a 100644 --- a/docs/ref/built-in-views.rst +++ b/docs/ref/built-in-views.rst @@ -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 diff --git a/docs/ref/themes.rst b/docs/ref/themes.rst index 3a00aba..7180230 100644 --- a/docs/ref/themes.rst +++ b/docs/ref/themes.rst @@ -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. \ No newline at end of file +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.