Ссылки на другие пакеты в sphinx - PullRequest
Новая
       95

Ссылки на другие пакеты в sphinx

0 голосов
/ 08 мая 2020

Я использую расширение sphinx_autodoc_typehints для своего проекта python.

В моем проекте у меня есть несколько зависимостей от других пакетов, таких как my_base_package.

[setup.py] 

setup(
  install_requires=[
    "my_base_package @ git+ssh://xxxxxx"
  ]
)

Возможно ли, что sphinx может отображать / ссылаться на классы, интерфейсы и исключения из «my_base_package» в документации моего проекта?

Возможно, пример немного лучше иллюстрирует мои опасения. Например, в моем "my_base_package" я добавил модуль, который может создать регистратор. 

[my_base_package]
def create_logger() -> Logger

В моем проекте, который зависит от "my_base_package", я хочу создать регистратор. Поэтому я использую модуль в my_base_package. 

[my_project]
import my_base_package.logger    

def setup():
  logger = my_base_package.create_logger()

def log(logger: Logger) -> None
  """Log

  :param logger: logger to log
  """
  logger.log_something()

Создавая документацию, sphinx показывает тип параметра для регистратора, но он не связан с реализацией в my_base_package. Это возможно?

Моя текущая настройка документации для этого файла: 

 .. automodule:: my_project.logger
   :members:
...