Home
last modified time | relevance | path

Searched full:sphinx (Results 1 – 25 of 65) sorted by relevance

123

/qemu/docs/sphinx/
H A Dcompat.py2 Sphinx cross-version compatibility goop
18 import sphinx
19 from sphinx import addnodes, util
20 from sphinx.directives import ObjectDescription
21 from sphinx.environment import BuildEnvironment
22 from sphinx.roles import XRefRole
23 from sphinx.util import docfields
24 from sphinx.util.docutils import (
29 from sphinx.util.typing import TextlikeNode
32 MAKE_XREF_WORKAROUND = sphinx.version_info[:3] < (4, 1, 0)
[all …]
H A Dqmp_lexer.py11 """qmp_lexer is a Sphinx extension that provides a QMP lexer for code blocks."""
16 from sphinx import errors
37 def setup(sphinx): argument
38 """For use by the Sphinx extensions API."""
40 sphinx.require_sphinx('2.1')
41 sphinx.add_lexer('QMP', QMPExampleLexer)
43 sphinx.add_lexer('QMP', QMPExampleLexer())
H A Ddbusdoc.py8 """dbus-doc is a Sphinx extension that provides documentation from D-Bus XML."""
28 import sphinx
34 from sphinx.application import Sphinx
35 from sphinx.errors import ExtensionError
36 from sphinx.util import logging
37 from sphinx.util.docstrings import prepare_docstring
38 from sphinx.util.docutils import SphinxDirective, switch_source_input
39 from sphinx.util.nodes import nested_parse_with_titles
160 def setup(app: Sphinx) -> Dict[str, Any]: argument
161 """Register dbus-doc directive with Sphinx"""
H A Dfakedbusdoc.py8 """dbus-doc is a Sphinx extension that provides documentation from D-Bus XML."""
11 from sphinx.application import Sphinx
23 def setup(app: Sphinx) -> Dict[str, Any]: argument
24 """Register a fake dbus-doc directive with Sphinx"""
H A Dhxtool.py9 """hxtool is a Sphinx extension that implements the hxtool-doc directive"""
26 from sphinx.errors import ExtensionError
27 from sphinx.util.docutils import switch_source_input
28 from sphinx.util.nodes import nested_parse_with_titles
29 import sphinx
96 # Tell sphinx of the dependency
158 # Sphinx counts its lines from 0
176 # Sphinx between 1.6 and 1.7. Unlike kerneldoc.py, we use
177 # sphinx.util.nodes.nested_parse_with_titles() rather than the
187 """ Register hxtool-doc directive with Sphinx"""
H A Dqapidoc.py12 qapidoc is a Sphinx extension that implements the qapi-doc directive
24 The Sphinx documentation on writing extensions is at:
25 https://www.sphinx-doc.org/en/master/development/index.html
60 from sphinx import addnodes
61 from sphinx.directives.code import CodeBlock
62 from sphinx.errors import ExtensionError
63 from sphinx.util import logging
64 from sphinx.util.docutils import SphinxDirective, switch_source_input
65 from sphinx.util.nodes import nested_parse_with_titles
80 from sphinx.application import Sphinx
[all …]
H A Dkerneldoc.py41 import sphinx
42 from sphinx.util import logging
43 from sphinx.util.docutils import switch_source_input
68 # Sphinx versions
69 cmd += ['-sphinx-version', sphinx.__version__]
78 # Tell sphinx of the dependency
134 # sphinx counts lines from 0
H A Ddbusdomain.py1 # D-Bus sphinx domain extension
24 from sphinx import addnodes
25 from sphinx.addnodes import desc_signature, pending_xref
26 from sphinx.directives import ObjectDescription
27 from sphinx.domains import Domain, Index, IndexEntry, ObjType
28 from sphinx.locale import _
29 from sphinx.roles import XRefRole
30 from sphinx.util import nodes as node_utils
31 from sphinx.util.docfields import Field, TypedField
32 from sphinx.util.typing import OptionSpec
H A Dqapi_domain.py23 from sphinx import addnodes
24 from sphinx.directives import ObjectDescription
25 from sphinx.domains import (
31 from sphinx.locale import _, __
32 from sphinx.roles import XRefRole
33 from sphinx.util import logging
34 from sphinx.util.docutils import SphinxDirective
35 from sphinx.util.nodes import make_id, make_refnode
59 from sphinx.addnodes import desc_signature, pending_xref
60 from sphinx.application import Sphinx
[all …]
H A Dqapidoc_legacy.py12 qapidoc is a Sphinx extension that implements the qapi-doc directive
24 The Sphinx documentation on writing extensions is at:
25 https://www.sphinx-doc.org/en/master/development/index.html
52 """A QAPI schema visitor which generates docutils/Sphinx nodes
54 This class builds up a tree of docutils/Sphinx nodes corresponding
64 from a Sphinx directive's 'run' method).
250 # Sphinx cannot handle sectionless titles;
430 # isn't anything in the ViewList corresponding to that then Sphinx
H A Ddepfile.py10 """depfile is a Sphinx extension that writes a dependency file for
14 import sphinx
/qemu/docs/devel/
H A Dqapi-domain.rst2 The Sphinx QAPI Domain
6 <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
7 in Sphinx is provided by the QAPI Domain, located in
8 ``docs/sphinx/qapi_domain.py``. This extension is analogous to the
10 <https://www.sphinx-doc.org/en/master/usage/domains/python.html>`_
11 included with Sphinx, but provides special directives and roles
16 <https://www.sphinx-doc.org/en/master/usage/domains/index.html>`_
18 Sphinx for understanding rST markup written to document a specific
21 <https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_
22 functionality is provided elsewhere, in ``docs/sphinx/qapidoc.py``, by
[all …]
H A Ddocs.rst7 built using the Sphinx documentation generator. We generate both
19 * a Sphinx extension in ``docs/sphinx/hxtool.py`` generates rST output
65 is included into two separate Sphinx documents, and some
66 versions of Sphinx will complain about the duplicate label
/qemu/docs/
H A Dconf.py4 # sphinx-quickstart on Thu Jan 31 16:40:14 2019.
8 # for each of QEMU's manuals: in this case sphinx-build is run multiple
11 # the manuals into a single document: in this case sphinx-build is
31 import sphinx
32 from sphinx.errors import ConfigError
46 # Our extensions are in docs/sphinx; the qapidoc extension requires
48 sys.path.insert(0, os.path.join(qemu_docdir, "sphinx"))
54 # If your documentation needs a minimal Sphinx version, state it here.
56 # 3.4.3 is the oldest version of Sphinx that ships on a platform we
60 # Add any Sphinx extension module names here, as strings. They can be
[all …]
H A Dmeson.build1 sphinx_build = find_program(fs.parent(python.full_path()) / 'sphinx-build',
8 # If we're making warnings fatal, apply this to Sphinx runs as well
27 # version requirement). This will fail if sphinx-build is too old.
28 run_command('mkdir', ['-p', tmpdir / 'sphinx'], check: true)
29 run_command('touch', [tmpdir / 'sphinx/index.rst'], check: true)
32 '-b', 'html', tmpdir / 'sphinx',
33 tmpdir / 'sphinx/out'], check: false)
39 error('Install a Python 3 version of python-sphinx and the readthedoc theme')
/qemu/
H A Dpythondeps.toml17 # 'sphinx-build' can be used as a bellwether for the
18 # presence of 'sphinx' in the system.
27 sphinx = { accepted = ">=3.4.3", installed = "5.3.0", canary = "sphinx-build" }
H A D.readthedocs.yml14 # Build documentation in the docs/ directory with Sphinx
15 sphinx:
/qemu/python/tests/
H A Dqapi-flake8.sh5 ../docs/sphinx/qapidoc.py \
6 ../docs/sphinx/qapi_domain.py
H A Dqapi-pylint.sh7 ../docs/sphinx/qapidoc.py \
8 ../docs/sphinx/qapi_domain.py
H A Dqapi-isort.sh7 ../docs/sphinx/qapi_domain.py \
8 ../docs/sphinx/qapidoc.py
/qemu/tests/docker/
H A Dtest-misc17 requires_binary sphinx-build-3 sphinx-build
/qemu/.gitlab-ci.d/cirrus/
H A Dmacos-14.vars15 PYPI_PKGS='PyYAML numpy pillow sphinx sphinx-rtd-theme tomli'
/qemu/tests/lcitool/
H A Dmappings.yml49 python3-sphinx:
52 python3-sphinx-rtd-theme:
/qemu/tests/lcitool/projects/
H A Dqemu.yml100 - python3-sphinx
101 - python3-sphinx-rtd-theme
/qemu/tests/qapi-schema/
H A Dmeson.build242 # file through Sphinx's plain-text builder and comparing the result against
243 # a golden reference. This is in theory susceptible to failures if Sphinx
245 # (no changes between Sphinx 1.6 and 3.0), so it is a better bet than
248 # fuzzy comparison if future Sphinx versions produce different text,
255 # We use -E to suppress Sphinx's caching, because

123