Home
last modified time | relevance | path

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

12345678

/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
21 sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\
55 # Prevent building with an outdated version of sphinx
58 # to load local extension from the folder 'sphinx'
59 sys.path.insert(0, os.path.abspath('sphinx'))
61 # Add any Sphinx extension module names here, as strings. They can be
62 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
65 'sphinx.ext.autosectionlabel',
66 '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/linux/Documentation/
H A DMakefile2 # Makefile for Sphinx documentation
19 SPHINXBUILD = sphinx-build
35 # User-friendly check for sphinx-build
41 …$(warning The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed and in P…
43 @$(srctree)/scripts/sphinx-pre-install
44 @echo " SKIP Sphinx $@ target."
64 # Let Sphinx know we will include rustdoc
74 # $2 sphinx builder e.g. "html"
82 quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
87 $(CONFIG_SHELL) $(srctree)/Documentation/sphinx/parallel-wrapper.sh \
[all …]
H A Dconf.py4 # sphinx-quickstart on Fri Feb 12 13:51:46 2016.
17 import sphinx
31 # Get Sphinx version
32 major, minor, patch = sphinx.version_info[:3]
39 print('WARNING: support for Sphinx < 2.4 will be removed soon.')
44 sys.path.insert(0, os.path.abspath('sphinx'))
49 # If your documentation needs a minimal Sphinx version, state it here.
52 # Add any Sphinx extension module names here, as strings. They can be
53 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
56 'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
[all …]
/openbmc/linux/Documentation/doc-guide/
H A Dsphinx.rst4 Using Sphinx for kernel documentation
7 The Linux kernel uses `Sphinx`_ to generate pretty documentation from
12 .. _Sphinx: http://www.sphinx-doc.org/
27 Sphinx Install
31 built with ``Sphinx`` version 1.7 or higher.
33 There's a script that checks for the Sphinx requirements. Please see
34 :ref:`sphinx-pre-install` for further details.
36 Most distributions are shipped with Sphinx, but its toolchain is fragile,
42 Sphinx inside a virtual environment, using ``virtualenv-3``
48 on the Sphinx version, it should be installed separately,
[all …]
/openbmc/linux/Documentation/translations/it_IT/doc-guide/
H A Dsphinx.rst9 Usare Sphinx per la documentazione del kernel
12 Il kernel Linux usa `Sphinx`_ per la generazione della documentazione a partire
18 .. _Sphinx: http://www.sphinx-doc.org/
35 Installazione Sphinx
39 processati da ``Sphinx`` nella versione 1.7 o superiore.
41 Esiste uno script che verifica i requisiti Sphinx. Per ulteriori dettagli
44 La maggior parte delle distribuzioni Linux forniscono Sphinx, ma l'insieme dei
46 Sphinx, o qualche altro pacchetto Python, la documentazione non venga più
51 vi raccomandiamo di installare Sphinx dentro ad un ambiente virtuale usando
58 A seconda della versione di Sphinx, potrebbe essere necessaria
[all …]
/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/linux/Documentation/translations/zh_CN/doc-guide/
H A Dsphinx.rst3 :Original: Documentation/doc-guide/sphinx.rst
12 Linux内核使用 `Sphinx <http://www.sphinx-doc.org/>`_ 来把 ``Documentation``
32 :ref:`sphinx-pre-install_zh` 。
53 (sphinx_2.4.4) $ pip install -r Documentation/sphinx/requirements.txt
87 $ ./scripts/sphinx-pre-install
95 pip install -r Documentation/sphinx/requirements.txt
97 Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468.
120 要生成文档，显然必须安装Sphinx（ ``sphinx-build`` ）。要让HTML输出更漂亮，可以
139 .. _主目录树: http://www.sphinx-doc.org/en/stable/markup/toctree.html
146 请参阅 `Sphinx <http://www.sphinx-doc.org/>`_ 和 `reStructuredText
[all …]
/openbmc/linux/scripts/
H A Dsphinx-pre-install12 my $requirement_file = $prefix . "Documentation/sphinx/requirements.txt";
165 next if ($dir =~ m,($cur_dir)/sphinx,);
169 next if ($dir =~ m,($cur_dir)/sphinx,);
249 my $fname = "sphinx-build";
252 $fname = "sphinx-build-3";
268 if (m/^\s*sphinx-build\s+([\d\.]+)((\+\/[\da-f]+)|(b\d+))?$/) {
272 # Sphinx 1.2.x uses a different format
273 if (m/^\s*Sphinx.*\s+([\d\.]+)$/) {
299 if (m/^\s*Sphinx\s*==\s*([\d\.]+)$/) {
306 die "Can't get default sphinx version from $requirement_file" if (!$default_version);
[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/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/linux/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
48 # Get Sphinx version
49 major, minor, patch = sphinx.version_info[:3]
[all …]
H A Dautomarkup.py8 import sphinx
9 from sphinx import addnodes
10 if sphinx.version_info[0] < 2 or \
11 sphinx.version_info[0] == 2 and sphinx.version_info[1] < 1:
12 from sphinx.environment import NoUri
14 from sphinx.errors import NoUri
29 # other way. Sphinx doesn't like a lot of stuff right after a
36 # Sphinx 2 uses the same :c:type role for struct, union, enum and typedef
42 # Sphinx 3 uses a different C role for each one of struct, union, enum and
95 if sphinx.version_info[0] >= 3:
[all …]
/openbmc/qemu/docs/sphinx/
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.py11 qapidoc is a Sphinx extension that implements the qapi-doc directive
23 The Sphinx documentation on writing extensions is at:
24 https://www.sphinx-doc.org/en/master/development/index.html
40 from sphinx import addnodes
41 from sphinx.directives.code import CodeBlock
42 from sphinx.errors import ExtensionError
43 from sphinx.util.docutils import switch_source_input
44 from sphinx.util.nodes import nested_parse_with_titles
68 """A QAPI schema visitor which generates docutils/Sphinx nodes
70 This class builds up a tree of docutils/Sphinx nodes corresponding
[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
/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
44 # Add any Sphinx extension module names here, as strings. They can be
45 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
48 'sphinx.ext.autosectionlabel',
49 'sphinx.ext.extlinks',
81 sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\
88 html_static_path = ['sphinx-static']
94 # 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
/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

12345678