Hello,
This is my code.
my_package (that contains __init__.py and fct1.py)
__init__.py
"""
.. automodule:: consoleMod.fct1
:members:
"""
import fct1
def publicfct1(a, b):
""" This is the public method of my_package
For more detail see fct1.internal_fct1
"""
fct1.internal_fct1(a+b)
fct1.py
def internal_fct1(a):
""" this is the internal code for publicfct1. Notice that we use only one
parameter"""
return a
The index.rst contains
.. automodule::my_package
I have 2 questions :
1°) Sphinx creates documentation for my_package.fct1.internal_fct1. OK, this is
nice. How to generate the documentation for my_package.publicfct1() ?
2°) Is it possible to differenciate public and internal function ? Is there a
public or private tag ? Change the background color ? Change the color of the
char set ?
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.
