Arhn - архитектура программирования

Sphinx, документирующий содержимое словаря (константа модуля)

Это в некоторой степени связано с Как документировать константу модуля в Python? но не то же самое.

У меня есть константа в модуле (это дикт):

possiblestringencodings = dict(
    StringsAsBytes=1,
    ascii=1,
    utf8=1, utf_8=1, U8=1,
    utf16=2, utf_16=2, U16=2, utf_16_be=2, utf_16_le=2,
    utf32=4, utf_32=4, U32=4, utf_32_be=4, utf_32_le=4,
)

На странице readthedocs есть (см. документы autodata ):

.. autodata:: construct.possiblestringencodings

Однако это создает строку документации из строки документации dict (его ctor). Как я могу документировать содержимое этого словаря, ТОЛЬКО его элементы, используя Sphinx?

введите здесь описание изображения

Если кто-то хочет попробовать исправить это, просто разветвите репозиторий и запустите «make html» внутри папки docs/. https://github.com/construct/construct/blob/1b53d9122a2c652db64c6558d101caee5bbbab3a/construct/core.py#L1280

python dictionary constants python-sphinx
01.02.2018

Ответы:


1

Элемент данных словаря не имеет строки документации, поэтому вы получаете ее из класса dict.

Немедленно добавьте пустой "комментарий к документации" перед определением (или строкой документации сразу после него), и на выходе вы получите только элементы словаря.

#:
possiblestringencodings = dict(
    StringsAsBytes=1,
    ascii=1,
    utf8=1, utf_8=1, U8=1,
    utf16=2, utf_16=2, U16=2, utf_16_be=2, utf_16_le=2,
    utf32=4, utf_32=4, U32=4, utf_32_be=4, utf_32_le=4,
)

Вам также необходимо полностью квалифицировать «основной» модуль:

.. autodata:: construct.core.possiblestringencodings
02.02.2018
  • Спасибо за вашу помощь, вы сделали много. Я установил sphinx и запустил make html локально, и действительно, страница была исправлена. По какой-то причине это только readthedocs, которые не исправлены этим. Можете ли вы отредактировать свой ответ, и мы оба удалим комментарии под ним? 03.02.2018
  • Готово, разместил ссылки на репо. 04.02.2018
    • Новые материалы
    Коллекции публикаций по глубокому обучению
    Последние пару месяцев я создавал коллекции последних академических публикаций по различным подполям глубокого обучения в моем блоге https://amundtveit.com - эта публикация дает обзор 25..
    Представляем: Pepita
    Фреймворк JavaScript с открытым исходным кодом Я знаю, что недостатка в фреймворках JavaScript нет. Но я просто не мог остановиться. Я хотел написать что-то сам, со своими собственными..
    Советы по коду Laravel #2
    1-) Найти // You can specify the columns you need // in when you use the find method on a model User::find(‘id’, [‘email’,’name’]); // You can increment or decrement // a field in..
    Работа с временными рядами спутниковых изображений, часть 3 (аналитика данных)
    Анализ временных рядов спутниковых изображений для данных наблюдений за большой Землей (arXiv) Автор: Рольф Симоэс , Жильберто Камара , Жильберто Кейрос , Фелипе Соуза , Педро Р. Андраде ,..
    3 способа решить квадратное уравнение (3-й мой любимый) -
    1. Методом факторизации — 2. Используя квадратичную формулу — 3. Заполнив квадрат — Давайте поймем это, решив это простое уравнение: Мы пытаемся сделать LHS,..
    Создание VR-миров с A-Frame
    Виртуальная реальность (и дополненная реальность) стали главными модными терминами в образовательных технологиях. С недорогими VR-гарнитурами, такими как Google Cardboard , и использованием..
    Демистификация рекурсии
    КОДЕКС Демистификация рекурсии Упрощенная концепция ошеломляющей О чем весь этот шум? Рекурсия, кажется, единственная тема, от которой у каждого начинающего студента-информатика..