Свързани въпроси 'python-sphinx'
Как да определим името на препратка, без заглавие на процедурата? (реструктуриран текст)
В reStructuredText е обичайно да се използват препратки за връзка произволни местоположения в документ.
Когато няма заглавие, е необходимо да се даде надпис с препратката. например:
Some text in a paragraph.
.. _my-reference:
Some more...
152 изгледи
schedule
17.09.2022
Как да добавите начални/крайни интервали към монопространствен текст в Sphinx reStructuredText
Заглавието казва всичко... това работи за създаване на монопространствен текст:
``foo``
но тези не:
`` foo``
``foo ``
Как мога да получа начални/крайни интервали в монопространствен текст? (преди някой да ми цитира XY проблем: това...
538 изгледи
schedule
14.09.2022
Променете името на модул в autodoc на Python Sphinx
Търся автоматично документиране на някои функции в модул на Python, използвайки autofunction . Да кажем, например, че функциите са дефинирани в mylib/funcs/a.py и този файл изглежда по следния начин:
def myfunc(arg):
""" My function does...
532 изгледи
schedule
21.09.2022
Sphinx - каква е разликата между toctree и съдържание?
Мога да създам съдържание по два начина:
.. contents::
:local:
depth: 1
or as
.. toctree::
:maxdepth: 1
index
Каква е разликата? Къде трябва да използвам tocttree и къде съдържанието?
841 изгледи
schedule
21.09.2022
Защо sphinx-apidoc не може да намери пакета в тази сборка на travis/tox?
Travis build: https://travis-ci.com/Laurentiu-Andronache/he/jobs/184044676
conf.py: https://github.com/Laurentiu-Andronache/he/blob/master/docs/source/conf.py
tox.ini: https://github.com/Laurentiu-Andronache/he/blob/master/tox.ini (вижте...
55 изгледи
schedule
21.09.2022
Как да генерирам черно-бял pdf от sphinx?
Искам да генерирам PDF от sphinx, който е само черно-бял. Стандартът sphinx.sty използва \RequirePackage{color} и \RequirePackage{fancyvrb} .
Ако просто премахна color , получавам цял списък с грешки. Не можах да намеря препратка в...
201 изгледи
schedule
09.12.2022
Къде е директорията с документи на django-sphinxdoc
Бих искал да използвам пакета django-sphinxdoc за документация в моя django проект. Има сайт https://pypi.python.org/pypi/django-sphinxdoc/ от този пакет и казва:
Документацията може да бъде намерена в директорията docs/.
Не мога да...
164 изгледи
schedule
07.11.2023
Заглавия на секции в страничната лента на Sphinx
Има ли някакъв начин да добавите заглавия на секции в лявото меню на документацията на Sphinx? Знам, че можете да го направите, ако използвате MkDocs (например тук ), но има ли начин да направите това в Sphinx и ReSTructured text?
Искам да...
1423 изгледи
schedule
27.01.2024
Документация на Sphinx за шаблонни етикети на Django
Използвам Sphinx с autodoc за документиране на моя Django проект.
Момчетата от дизайна искат да имат страница(и) с документация за всички шаблонни тагове, които са дефинирани в проекта. Разбира се, мога да направя такава страница, като изброя на...
948 изгледи
schedule
20.03.2024
Как да направите вътрешна хипервръзка в документацията на Sphinx
Как да направя вътрешна хипервръзка в документацията на Sphinx? Използвам:
:role:`target`
Но не работи.
15060 изгледи
schedule
24.03.2024
Как да настроя дълбочината на Sphinx и latexpdf toc?
Имам проект за ванилов сфинкс (Sphinx 1.2b3.), създаден с "sphinx-quickstart"
Добавям основна страница.rst с 4 нива на заглавка.
Мога да контролирам дълбочината на html toc в index.rst:
.. toctree::
:maxdepth: 1
:numbered:
page...
2524 изгледи
schedule
12.05.2024
Добавяне на клас към таблица в Sphinx?
Имам таблица в rst и искам да добавя клас към нея, когато компилирам в HTML със Sphinx. Според документите , добавянето на директива .. class:: преди таблицата трябва добави класа към таблицата, но вместо това добавя списък с дефиниции.
Кодът...
4692 изгледи
schedule
11.01.2024