Hello,
For instance I have 2 methods
def internal_method(trace=False):
:param trace=False: to be completed
:return: to be completed
def public_methode(trace=True):
:param trace=True: to be completed
:return: to be completed
sphinx does it job and will create 2 HTML divisions: <dl class="function">, one
per method.
Is it possible to have something like :
def internal_method(trace=False):
:my_own_definition_for_internal
:param ....
def public_method(trace=True)
:my_own_definition_for_public
:param ....
Other possibility is to have :my_own_definition (parameter is public)
And is it possible to modify the html generator to say
function => dl class="function"
function with my_own_defintiion => dl class="function_public" or
class="function_internal" ...
Have you idea to do something like that?
The docString is a "body" so it is not possible to add RST directive like ..
my_own_definition_for_internal. So the simplest way is :
How to extend the docString language and modify the html generation ?
Thanks
PHL.
--
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.
For more options, visit https://groups.google.com/d/optout.
