Python: документация по именованным кордонам Sphinx - PullRequest
Новая
       100

Python: документация по именованным кордонам Sphinx

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

Я пытаюсь документировать namedtuple. Когда я создаю документы, я получаю предупреждение WARNING: duplicate object description и те же пустые функции после документированных. Например: enter image description here

Как удалить эти псевдонимы? Я уже пробовал это решение , записывая несколько функций для conf.py для создания пустых свойств.

Кроме того, я думаю, что стоит упомянуть, что после сборки я получаю примечание для использования :noindex: но я не понимаю, где мне его использовать? В моей документации, первый файл или где-то еще?

Пример кода: 


File = namedtuple("File", ["path", "size", "extension",
                           "adate", "mdate", "links",
                           "user_owner", "group_owner",
                           "inode", "device", "permissions",
                           "depth"])
"""File attributes.

.. py:attribute:: path

    **-** path to the found file

     .. note::
        depending on command-line arguments can be absolute or relative
...
...