В данном случае структура репозитория следующая:
../
docs/
sphinx # и все что с ним связано
Project/
__init__.py
modules
datatypes/ #package
__init__.py
interfaces.py
теперь, в сфинксе в conf.py, пока что для тестов самого autodoc, добавил абсолютный импорт:
import os
import sys
sys.path.insert(0, os.path.abspath('E:\progr\Git\PyKSP'))
и внутри файла документации хочу сделать отдельный радел с автоматической документацией исходников:
.. toctree::
:caption: Contents:
part2_interfaces_module.rst
*********************************
Модуль PyKSP.datatypes.interfaces
*********************************
.. automodule:: PyKSP.datatypes.interfaces
:members:
И в принципе, все работает, но при сборке появляется такая вот портянка
E:\progr\Git\PyKSP\PyKSP\datatypes\interfaces.py:docstring of PyKSP.datatypes.interfaces.Callable:1: WARNING: duplicate object description of PyKSP.datatypes.interfaces.Callable, other instance in E:\progr\Git\PyKSP\blog\part2_looking_for_architacture.rst, use :noindex: for one of them
погуглил stackoverflow, нашел только один вопрос без нормального решения:
https://stackoverflow.com/questions/39738852/duplicate-index-warning-on-sphinx-build-how-do-i-include-a-file-without-indexin
все норм, или как-то можно нивелировать это?
Ну и второй вопрос в принципе, гуглится лучше, но пока сходу не получилось: релативный импорт пакета из директории выше, чтоб автодок смог по нему пройти.
И вообще, может есть хорошее руководство или учебник по автодоку, кроме официальной страницы на сайте sphinx?