Move api documentation to a separate folder.

This commit is contained in:
tisto 2012-01-25 23:06:42 +01:00 committed by Timo Stollenwerk
parent 7d34baf2d5
commit 65590732ea
7 changed files with 31 additions and 13 deletions

View File

@ -0,0 +1 @@
.. include:: ../../../plone/app/discussion/comment.txt

View File

@ -0,0 +1 @@
.. include:: ../../../plone/app/discussion/conversation.txt

View File

@ -1,5 +1,6 @@
API/Interfaces ===
-------------- API
===
The conversation and replies adapters. The conversation and replies adapters.
@ -12,6 +13,9 @@ directly in reply to a particular comment (implemented by the CommentReplies
adpater) or at the top level of the conversation (implemented by the adpater) or at the top level of the conversation (implemented by the
ConversationReplies adapter). ConversationReplies adapter).
.. include:: ../../plone/app/discussion/conversation.txt
.. include:: ../../plone/app/discussion/comment.txt .. toctree::
:maxdepth: 1
conversation.txt
comment.txt

View File

@ -3,7 +3,7 @@
# plone.app.discussion documentation build configuration file, created by # plone.app.discussion documentation build configuration file, created by
# sphinx-quickstart on Thu Mar 18 10:17:15 2010. # sphinx-quickstart on Thu Mar 18 10:17:15 2010.
# #
# This file is execfile()d with the current directory set to its containing dir. # This file is execfile()d with the current directory set to its containing dir
# #
# Note that not all possible configuration values are present in this # Note that not all possible configuration values are present in this
# autogenerated file. # autogenerated file.
@ -11,23 +11,25 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys, os import sys
import os
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.append(os.path.abspath('.')) #sys.path.append(os.path.abspath('.'))
# -- General configuration ----------------------------------------------------- # -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', extensions = ['sphinx.ext.autodoc',
'sphinx.ext.doctest', 'sphinx.ext.doctest',
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinx.ext.coverage', 'sphinx.ext.coverage',
'repoze.sphinx.autointerface',] 'repoze.sphinx.autointerface'
]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.

View File

@ -17,11 +17,10 @@ Contents:
architecture.txt architecture.txt
design.txt design.txt
workflow.txt workflow.txt
comments.txt
captcha.txt captcha.txt
email-notification.txt email-notification.txt
api/index.txt
howtos/index.txt howtos/index.txt
api.txt
changes.txt changes.txt

View File

@ -1,7 +1,17 @@
=======
Comment Comment
======= =======
.. literalinclude:: ../../plone/app/discussion/interfaces.py Member:
creator: username of the commenter (None for anonymous commenters).
author_name: full name of the commenter
author_email: email of the commenter
author_username: username of the commenter
.. literalinclude:: interfaces.py
:language: python :language: python
:pyobject: IComment :pyobject: IComment

View File

@ -1,3 +1,4 @@
============
Conversation Conversation
============ ============