Результаты поиска по запросу "python-sphinx"
Ссылка на метод класса в документации строки Python
Я хочу добавить ссылку на метод в моем классе из строки документа другого метода того же класса. Я хочу, чтобы ссылка работала в sphinx и, предпочтительно, также в Spyder и других Python IDE. Я попробовал несколько вариантов и нашел только один, ...
Добавление тега javascript script в какое-то место, чтобы он работал для каждого файла в документации sphinx
Я использую Сфинкс, чтобы написать несколько заметок. Я использую расширение Mathjax для Math в примечаниях. Размер математики по умолчанию немного больше, чем хотелось бы. На странице Mathjax я обнаружил, что могу изменить этот размер, добавив ...
Как мне создать глобальную роль / роли в Sphinx?
Это продолжение "ReST Strikethrough"ReST зачеркнутый [https://stackoverflow.com/q/6518788/1268478]но в сфинксе, а не в контексте ReST. Мой вопрос заключается в том, есть ли в sphinx центральное место, куда следует помещать директиву «роль», или ...
Как установить пользовательское значение конфигурации для sphinx в conf.py? (например, для sphinx.ext.ifconfig)
[Я разделил первоначальный вопрос на два после дополнительного тестирования и исследований] Я определил свое собственное значение конфигурации в conf.py и написал минимальное расширение, чтобы сделать его видимым из первых файлов. в ...
Сфинкс: список функций в модуле
У меня есть несколько модулей Python, содержащих в основном функции и несколько классов. Каждый документ документирован с использованием sphinx-autodoc в отдельном файле. То, что я хочу сделать, это создать таблицу или список содержимого модуля в ...
Отключение отдельных предупреждений Sphinx
у меня много.rst файлы в моем дереве Сфинкса, которые намеренно исключены из любого дерева индексов. Я получаю предупреждения как /filename.rst:: WARNING: document isn't included in any toctreeКак я могу подавить определенные предупреждения в ...
Переопределение ограничения имени поля по умолчанию в sphinx / documentstils
Я используюсфинкс [http://sphinx.pocoo.org/]для создания HTML-документации для проекта. Я широко используюсписки полей [http://docutils.sourceforge.net/docs/user/rst/quickref.html#field-lists]. При создании html каждая пара метка / значение ...
Ограничения разметки Sphinx LaTeX
Я пытаюсь сделать три действительно простых вещи в многострочном математическом режиме в Sphinx (версия 1.1.2-1). Напишите подчеркивание как часть моих имен переменных даже в математическом режиме;Использовать\big, \bigglи т. д., разделители для ...
Переопределить шаблон HTML-страницы для конкретного документа сфинкса
Я реализую документацию с использованием Sphinx ( https://github.com/fridge-project/dbal-docs [https://github.com/fridge-project/dbal-docs]) & хотел бы переопределить HTML-страницу конкретного документа. Меня интересует переопределение ...
Сфинкс генерирует пустую документацию
Я пытаюсь сгенерировать документацию для своего проекта с помощью Sphinx, но выходная документация не содержит ни одного из моих классов. Что я делаю неправильно? Ниже приведены команды, которые я использую для создания документации: > ls ...