mirror of
https://github.com/jazzband/django-admin2.git
synced 2026-03-16 22:20:24 +00:00
Getting the built-in-views to load in autodoc
This commit is contained in:
parent
24f67b9c07
commit
f469e8f25e
4 changed files with 60 additions and 8 deletions
45
docs/built-in-views.rst
Normal file
45
docs/built-in-views.rst
Normal file
|
|
@ -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:
|
||||
|
||||
|
|
@ -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 -----------------------------------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -61,6 +61,7 @@ Content
|
|||
architecture
|
||||
api
|
||||
themes
|
||||
built-in-views
|
||||
meta
|
||||
tutorial
|
||||
|
||||
|
|
|
|||
|
|
@ -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!
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue