У меня есть пакет Python, в котором есть метод:
from felling.src.email import send_email
Следуя тому, как Pandas обрабатывает импорт, такой как pandas.DataFrame в вырубке.__init__.py, у меня есть:
# felling.__init__.py
from felling.src.email import send_email
Что позволяет кому-либо импортировать файл Felling.src.email.send_email с помощью:
from felling import send_email
Поскольку этот последний метод импорта является основным, я намереваюсь импортировать send_email. Никто никогда не запускается из pandas.core.api import DataFrame, несмотря на то, что это действительно.
При документировании вырубки с помощью Sphinx он документирует send_email как вырубку. src.email.send_email, а не Felling.email. Я прочитал документацию Pandas и не могу понять, как они заставляют Sphinx документировать pandas.core.api.DataFrame как pandas.DataFrame.
Как я могу сделать это?
Пример .py
# felling.src.email
def send_email(to:str, subject:str):
"""
Send an email
Parameters
----------
to : str
Who should receive the email
subject : str
What should the emails subject be
"""
print(to)
print(subject)
Пример .rst
felling methods
===============
A package for logging
felling.src.email
------------------------
.. automodule:: felling.src.email
:members:
:undoc-members:
:show-inheritance:
Дерево Феллинга
├── README.md
├── __init__.py
├── __main__.py
├── resources
│ └── logger.json
├── src
│ ├── __init__.py
│ ├── compare_logs.py
│ ├── configure_felling.py
│ └── email.py
└── version.py
Подробнее здесь: https://stackoverflow.com/questions/667 ... ith-sphinx
