qpid-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (Jira)" <j...@apache.org>
Subject [jira] [Commented] (PROTON-2086) Move Python API docs to use Sphinx
Date Wed, 28 Aug 2019 14:20:00 GMT

    [ https://issues.apache.org/jira/browse/PROTON-2086?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16917818#comment-16917818
] 

ASF GitHub Bot commented on PROTON-2086:
----------------------------------------

kpvdr commented on pull request #186: PROTON-2086: Changed API documentation from epydoc to
Sphinx
URL: https://github.com/apache/qpid-proton/pull/186#discussion_r318608359
 
 

 ##########
 File path: python/docs/proton.handlers.rst
 ##########
 @@ -0,0 +1,106 @@
+##########################
+Module ``proton.handlers``
+##########################
+
+.. currentmodule:: proton.handlers
+
+Module Summary
+##############
+
+|
+
+.. autosummary::
+
+    MessagingHandler
+    EndpointStateHandler
 
 Review comment:
   I'll remove the following handlers:
   
   - EndpointStateHandler
   - IncomingMessageHandler
   - OutgoingMessageHandler
   
   which will leave only the following:
   
   - MessagingHandler
   - TransactionHandler
   - TransactionalClientHandler
   
   I don't know the transaction handlers well, but looking at the code, it appears that TransactionalClientHandler
inherits from both TransactionHandler and MessagingHandler, so is intended to be the one to
use for transactions from a client API pov. I think we should also drop TransactionHandler
if you agree.
 
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Move Python API docs to use Sphinx
> ----------------------------------
>
>                 Key: PROTON-2086
>                 URL: https://issues.apache.org/jira/browse/PROTON-2086
>             Project: Qpid Proton
>          Issue Type: Task
>          Components: python-binding
>            Reporter: Kim van der Riet
>            Assignee: Kim van der Riet
>            Priority: Major
>
> Currently the Python API docs are generated using ePyDoc. These should be switched to
using Sphinx.



--
This message was sent by Atlassian Jira
(v8.3.2#803003)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@qpid.apache.org
For additional commands, e-mail: dev-help@qpid.apache.org


Mime
View raw message