From f469e8f25e4417f74a0b6f2e03e0b7600bad11d7 Mon Sep 17 00:00:00 2001 From: Daniel Greenfeld Date: Thu, 4 Jul 2013 12:35:39 +0200 Subject: [PATCH] Getting the built-in-views to load in autodoc --- docs/built-in-views.rst | 45 +++++++++++++++++++++++++++++++++++++++++ docs/conf.py | 9 ++++++++- docs/index.rst | 1 + docs/themes.rst | 13 ++++++------ 4 files changed, 60 insertions(+), 8 deletions(-) create mode 100644 docs/built-in-views.rst diff --git a/docs/built-in-views.rst b/docs/built-in-views.rst new file mode 100644 index 0000000..e5ccb4d --- /dev/null +++ b/docs/built-in-views.rst @@ -0,0 +1,45 @@ +Built-In Views +=============== + +TODO: Provide a list of template context variables for each template per GitHub issue `#220`_ + +.. _`#220`: https://github.com/twoscoops/django-admin2/issues/220 + +.. autoclass:: djadmin2.views.IndexView + :members: + + +.. autoclass:: djadmin2.views.AppIndexView + :members: + +.. autoclass:: djadmin2.views.ModelListView + :members: + + +.. autoclass:: djadmin2.views.ModelDetailView + :members: + +.. autoclass:: djadmin2.views.ModelEditFormView + :members: + +.. autoclass:: djadmin2.views.ModelAddFormView + :members: + + +.. autoclass:: djadmin2.views.ModelDeleteView + :members: + + +.. autoclass:: djadmin2.views.PasswordChangeView + :members: + +.. autoclass:: djadmin2.views.PasswordChangeDoneView + :members: + + +.. autoclass:: djadmin2.views.LoginView + :members: + +.. autoclass:: djadmin2.views.LogoutView + :members: + diff --git a/docs/conf.py b/docs/conf.py index cfe4730..d843649 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,14 @@ project_directory = os.path.dirname( sys.path.insert(0, os.path.join(project_directory, 'example')) sys.path.insert(1, project_directory) -os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.settings") +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.example.settings") + +sys.path.insert(0, os.path.abspath('../../')) +sys.path.insert(0, os.path.abspath('../')) + +from example.example import settings +from django.core.management import setup_environ +setup_environ(settings) # -- General configuration ----------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index a786bfb..4864518 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -61,6 +61,7 @@ Content architecture api themes + built-in-views meta tutorial diff --git a/docs/themes.rst b/docs/themes.rst index d598c7b..3a00aba 100644 --- a/docs/themes.rst +++ b/docs/themes.rst @@ -137,20 +137,19 @@ In the settings module, place the theme right after djadmin2 (change the highlig 'djadmin2_dandy' ) ########### END DJANGO-ADMIN2 CONFIGURATION + +.. TODO:: Have someone besides pydanny test this! -TODO ----- +Views and their Templates +------------------------- -1. Have someone besides pydanny test this! -2. Provide a list of template context variables for each template per GitHub issue `#220`_ - -.. _`#220`: https://github.com/twoscoops/django-admin2/issues/220 +See :ref:`Built-In Views` Available Themes ---------------- -Currently, only the "bootstrap" theme exists. The goal of this theme is to replicate the original Django admin UI functionality as closely as possible. This helps us ensure that we are not forgetting any functionality that Django users might be dependent on. +Currently, only the default "bootstrap" theme exists. The goal of this theme is to replicate the original Django admin UI functionality as closely as possible. This helps us ensure that we are not forgetting any functionality that Django users might be dependent on. If you'd like to experiment with UI design that differs from the original Django admin UI, please create a new theme. It would be great to have at least 1 experimental theme!