diff --git a/docs/conf.py b/docs/conf.py index aa866ac..d64744d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -91,7 +91,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'alabaster' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -240,3 +240,7 @@ texinfo_documents = [ # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' + +sys.path.insert(0, os.path.abspath('..')) +from django.conf import settings +settings.configure() diff --git a/docs/topics/appendix/instance-documentation.rst b/docs/topics/appendix/instance-documentation.rst new file mode 100644 index 0000000..5dc982c --- /dev/null +++ b/docs/topics/appendix/instance-documentation.rst @@ -0,0 +1,23 @@ +Class Documentation +=================== + +Mailbox +------- + +.. autoclass:: django_mailbox.models.Mailbox + :members: + :undoc-members: + +Message +------- + +.. autoclass:: django_mailbox.models.Message + :members: + :undoc-members: + +Message Attachment +------------------ + +.. autoclass:: django_mailbox.models.MessageAttachment + :members: + :undoc-members: