mirror of
https://github.com/coddingtonbear/django-mailbox.git
synced 2026-07-09 22:38:19 +02:00
Adding model documentation to docs; fixes #47.
This commit is contained in:
parent
3d5b816150
commit
e6fb545608
2 changed files with 28 additions and 1 deletions
|
|
@ -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()
|
||||
|
|
|
|||
23
docs/topics/appendix/instance-documentation.rst
Normal file
23
docs/topics/appendix/instance-documentation.rst
Normal file
|
|
@ -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:
|
||||
Loading…
Add table
Add a link
Reference in a new issue