kdschlosser <[email protected]> writes:

> I want to be able to use a decorator for logging purposes and I would like 
> to be able to provide some information in that log entry that would be 
> static information.
>
> I could make a lookup table of function/method names along with the 
> information I want to include but that seems to be a bit extreme. 
> Considering there is already a mechanism to be able to do this exact thing. 
> The issue would be that information being added to the documentation.
>
> Is there a comment flag or a directive that will stop sphinx from including 
> the line(s)?

Have you tried using the reStructuredText comment syntax?

def myfunc():
    """this is included

    so is this

    ..

       but this should not show in the output
    """

-- 
Doug

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/m2zhmfvxnn.fsf%40doughellmann.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to