Home
last modified time | relevance | path

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

123456

/openbmc/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 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 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 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 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 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
78 from sphinx.application import Sphinx
[all …]
/openbmc/openbmc/poky/documentation/
H A DREADME72 Sphinx
76 format to Sphinx based documentation for the Yocto Project 3.2
78 the Sphinx migration, and guidelines for developers willing to
81 Sphinx is a tool that makes it easy to create intelligent and
86 Extensive documentation is available on the Sphinx website:
87 https://www.sphinx-doc.org/en/master/. Sphinx is designed to be
111 To build the documentation, you need Sphinx and a few other packages,
156 To fix errors which are not reported by Sphinx itself,
157 the project uses sphinx-lint (https://github.com/sphinx-contrib/sphinx-lint).
159 To install sphinx-lint:
[all …]
H A Dconf.py1 # Configuration file for the Sphinx documentation builder.
7 # https://www.sphinx-doc.org/en/master/usage/configuration.html
22 sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\
56 # Prevent building with an outdated version of sphinx
59 # to load local extension from the folder 'sphinx'
60 sys.path.insert(0, os.path.abspath('sphinx'))
62 # Add any Sphinx extension module names here, as strings. They can be
63 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
66 'sphinx.ext.autosectionlabel',
67 'sphinx.ext.extlinks',
[all …]
H A DMakefile1 # Minimal makefile for Sphinx documentation
7 SPHINXBUILD ?= sphinx-build
20 $(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed")
53 @rm -rf $(BUILDDIR) $(PNGs) $(PDFs) poky.yaml sphinx-static/switchers.js releases.rst
59 sphinx-lint:
60 sphinx-lint $(SPHINXLINTDOCS)
75 # Catch-all target: route all unknown targets to Sphinx using the new
/openbmc/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
/openbmc/u-boot/Documentation/
H A DMakefile2 # Makefile for Sphinx documentation
8 SPHINXBUILD = sphinx-build
18 # User-friendly check for sphinx-build
24 …$(warning The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed and in P…
26 @./scripts/sphinx-pre-install
27 @echo " SKIP Sphinx $@ target."
46 # $2 sphinx builder e.g. "html"
54 quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
68 @+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
71 @$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var)))
[all …]
H A Dconf.py4 # sphinx-quickstart on Fri Feb 12 13:51:46 2016.
17 import sphinx
19 # Get Sphinx version
20 major, minor, patch = sphinx.version_info[:3]
26 sys.path.insert(0, os.path.abspath('sphinx'))
31 # If your documentation needs a minimal Sphinx version, state it here.
34 # Add any Sphinx extension module names here, as strings. They can be
35 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
39 # The name of the math extension changed on Sphinx 1.4
41 extensions.append("sphinx.ext.imgmath")
[all …]
/openbmc/openbmc/poky/bitbake/doc/
H A Dconf.py1 # Configuration file for the Sphinx documentation builder.
5 # https://www.sphinx-doc.org/en/master/usage/configuration.html
46 # Add any Sphinx extension module names here, as strings. They can be
47 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
50 'sphinx.ext.autosectionlabel',
51 'sphinx.ext.extlinks',
52 'sphinx.ext.autodoc',
84 sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\
91 html_static_path = ['sphinx-static']
97 # Hide 'Created using Sphinx' text
H A DREADME18 Sphinx
22 format to Sphinx based documentation for the Yocto Project 3.2
25 Additional information related to the Sphinx migration, and guidelines
34 Sphinx is written in Python. While it might work with Python2, for
38 Sphinx might be available in your Linux distro packages repositories,
41 distro. The recommended method to install Sphinx and all required
46 $ pip3 install sphinx sphinx_rtd_theme pyyaml
H A DMakefile1 # Minimal makefile for Sphinx documentation
7 SPHINXBUILD ?= sphinx-build
13 $(error "The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed")
32 # Catch-all target: route all unknown targets to Sphinx using the new
/openbmc/u-boot/Documentation/sphinx/
H A Dcdomain.py7 Replacement for the sphinx c-domain.
15 declarations in the nitpicky mode. See Sphinx documentation for
28 * :any:`VIDIOC_LOG_STATUS` (``:any:`` needs sphinx 1.3)
38 import sphinx
39 from sphinx import addnodes
40 from sphinx.domains.c import c_funcptr_sig_re, c_sig_re
41 from sphinx.domains.c import CObject as Base_CObject
42 from sphinx.domains.c import CDomain as Base_CDomain
46 # Get Sphinx version
47 major, minor, patch = sphinx.version_info[:3]
[all …]
/openbmc/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')
/openbmc/openbmc/poky/documentation/sphinx/
H A Dyocto-vars.py7 import sphinx
8 from sphinx.application import Sphinx
15 sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\
27 def subst_vars_replace(app: Sphinx, docname, source): argument
33 def yocto_vars_env_get_outdated(app: Sphinx, env, added, changed, removed): argument
56 def yocto_vars_build_finished(app: Sphinx, exception): argument
65 def setup(app: Sphinx): argument
/openbmc/openbmc/meta-openembedded/meta-python/recipes/devtool/
H A Dpython3-breathe_4.36.0.bb1 SUMMARY = "Sphinx Doxygen renderer"
2 DESCRIPTION = "Breathe is a Sphinx plugin providing beautifully integrated Doxygen output in your u…
11 RDEPENDS:${PN} = "python3-sphinx"
/openbmc/qemu/
H A Dpythondeps.toml17 # 'sphinx-build' can be used as a bellwether for the
18 # presence of 'sphinx' in the system.
31 sphinx = { accepted = ">=3.4.3", installed = "6.2.1", canary = "sphinx-build" }
/openbmc/openbmc/meta-arm/meta-arm-bsp/documentation/corstone1000/
H A Dconf.py6 # Configuration file for the Sphinx documentation builder.
10 # https://www.sphinx-doc.org/en/master/usage/configuration.html
36 # Add any Sphinx extension module names here, as strings. They can be
37 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
/openbmc/openbmc/meta-raspberrypi/docs/
H A Dconf.py5 # sphinx-quickstart on Tue May 23 09:51:24 2017.
26 # If your documentation needs a minimal Sphinx version, state it here.
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
68 # The language for content autogenerated by Sphinx. Refer to documentation
109 pygments_style = 'sphinx'
138 # The name for this set of Sphinx documents.
205 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
223 # Sphinx supports the following languages:

123456