├── .codecov.yml ├── .git-blame-ignore-revs ├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ ├── bug-report.yml │ ├── config.yml │ └── feature_request.md ├── PULL_REQUEST_TEMPLATE.md ├── dependabot.yml └── workflows │ ├── builddoc.yml │ ├── create-release.yml │ ├── lint.yml │ ├── lock.yml │ ├── main.yml │ ├── nodejs.yml │ └── transifex.yml ├── .gitignore ├── .mailmap ├── .prettierrc.toml ├── .readthedocs.yml ├── .ruff.toml ├── AUTHORS.rst ├── CHANGES.rst ├── CODE_OF_CONDUCT.rst ├── CONTRIBUTING.rst ├── EXAMPLES.rst ├── LICENSE.rst ├── Makefile ├── README.rst ├── bindep.txt ├── doc ├── Makefile ├── _static │ ├── Makefile │ ├── bookcover.png │ ├── diagrams │ │ ├── sphinx_build_flow.dot │ │ ├── sphinx_build_phases.dot │ │ └── sphinx_core_events_flow.dot │ ├── favicon.svg │ ├── jupyter-logo.png │ ├── linux-logo.png │ ├── python-logo.png │ ├── sphinx.png │ ├── themes │ │ ├── agogo.png │ │ ├── alabaster.png │ │ ├── bizstyle.png │ │ ├── classic.png │ │ ├── fullsize │ │ │ ├── agogo.png │ │ │ ├── alabaster.png │ │ │ ├── bizstyle.png │ │ │ ├── classic.png │ │ │ ├── haiku.png │ │ │ ├── nature.png │ │ │ ├── pyramid.png │ │ │ ├── scrolls.png │ │ │ ├── sphinx_rtd_theme.png │ │ │ ├── sphinxdoc.png │ │ │ └── traditional.png │ │ ├── haiku.png │ │ ├── nature.png │ │ ├── pyramid.png │ │ ├── scrolls.png │ │ ├── sphinx_rtd_theme.png │ │ ├── sphinxdoc.png │ │ └── traditional.png │ ├── translation.png │ ├── translation.puml │ ├── translation.svg │ └── tutorial │ │ ├── lumache-autosummary.png │ │ ├── lumache-first-light.png │ │ ├── lumache-furo.png │ │ ├── lumache-py-function-full.png │ │ └── lumache-py-function.png ├── _templates │ └── contents.html ├── _themes │ └── sphinx13 │ │ ├── layout.html │ │ ├── static │ │ ├── sphinx-logo.svg │ │ └── sphinx13.css │ │ └── theme.toml ├── authors.rst ├── changes │ ├── 0.1.rst │ ├── 0.2.rst │ ├── 0.3.rst │ ├── 0.4.rst │ ├── 0.5.rst │ ├── 0.6.rst │ ├── 1.0.rst │ ├── 1.1.rst │ ├── 1.2.rst │ ├── 1.3.rst │ ├── 1.4.rst │ ├── 1.5.rst │ ├── 1.6.rst │ ├── 1.7.rst │ ├── 1.8.rst │ ├── 2.0.rst │ ├── 2.1.rst │ ├── 2.2.rst │ ├── 2.3.rst │ ├── 2.4.rst │ ├── 3.0.rst │ ├── 3.1.rst │ ├── 3.2.rst │ ├── 3.3.rst │ ├── 3.4.rst │ ├── 3.5.rst │ ├── 4.0.rst │ ├── 4.1.rst │ ├── 4.2.rst │ ├── 4.3.rst │ ├── 4.4.rst │ ├── 4.5.rst │ ├── 5.0.rst │ ├── 5.1.rst │ ├── 5.2.rst │ ├── 5.3.rst │ ├── 6.0.rst │ ├── 6.1.rst │ ├── 6.2.rst │ ├── 7.0.rst │ ├── 7.1.rst │ ├── 7.2.rst │ ├── 7.3.rst │ ├── 7.4.rst │ ├── 8.0.rst │ ├── 8.1.rst │ ├── 8.2.rst │ └── index.rst ├── conf.py ├── development │ ├── howtos │ │ ├── builders.rst │ │ ├── index.rst │ │ └── setup_extension.rst │ ├── html_themes │ │ ├── index.rst │ │ └── templating.rst │ ├── index.rst │ └── tutorials │ │ ├── adding_domain.rst │ │ ├── autodoc_ext.rst │ │ ├── examples │ │ ├── README.rst │ │ ├── autodoc_intenum.py │ │ ├── helloworld.py │ │ ├── recipe.py │ │ └── todo.py │ │ ├── extending_build.rst │ │ ├── extending_syntax.rst │ │ └── index.rst ├── examples.rst ├── extdev │ ├── appapi.rst │ ├── builderapi.rst │ ├── collectorapi.rst │ ├── deprecated.rst │ ├── domainapi.rst │ ├── envapi.rst │ ├── event_callbacks.rst │ ├── i18n.rst │ ├── index.rst │ ├── logging.rst │ ├── markupapi.rst │ ├── nodes.rst │ ├── parserapi.rst │ ├── projectapi.rst │ ├── testing.rst │ └── utils.rst ├── faq.rst ├── glossary.rst ├── index.rst ├── internals │ ├── code-of-conduct.rst │ ├── contributing.rst │ ├── index.rst │ ├── organization.rst │ └── release-process.rst ├── latex.rst ├── make.bat ├── man │ ├── index.rst │ ├── sphinx-apidoc.rst │ ├── sphinx-autogen.rst │ ├── sphinx-build.rst │ └── sphinx-quickstart.rst ├── support.rst ├── tutorial │ ├── automatic-doc-generation.rst │ ├── deploying.rst │ ├── describing-code.rst │ ├── end.rst │ ├── first-steps.rst │ ├── getting-started.rst │ ├── index.rst │ ├── more-sphinx-customization.rst │ └── narrative-documentation.rst └── usage │ ├── advanced │ ├── intl.rst │ └── websupport │ │ ├── api.rst │ │ ├── index.rst │ │ ├── quickstart.rst │ │ ├── searchadapters.rst │ │ └── storagebackends.rst │ ├── builders │ └── index.rst │ ├── configuration.rst │ ├── domains │ ├── c.rst │ ├── cpp.rst │ ├── index.rst │ ├── javascript.rst │ ├── mathematics.rst │ ├── python.rst │ ├── restructuredtext.rst │ └── standard.rst │ ├── extensions │ ├── apidoc.rst │ ├── autodoc.rst │ ├── autosectionlabel.rst │ ├── autosummary.rst │ ├── coverage.rst │ ├── doctest.rst │ ├── duration.rst │ ├── example_google.py │ ├── example_google.rst │ ├── example_numpy.py │ ├── example_numpy.rst │ ├── extlinks.rst │ ├── githubpages.rst │ ├── graphviz.rst │ ├── ifconfig.rst │ ├── imgconverter.rst │ ├── index.rst │ ├── inheritance.rst │ ├── intersphinx.rst │ ├── linkcode.rst │ ├── math.rst │ ├── napoleon.rst │ ├── todo.rst │ └── viewcode.rst │ ├── index.rst │ ├── installation.rst │ ├── markdown.rst │ ├── quickstart.rst │ ├── referencing.rst │ ├── restructuredtext │ ├── basics.rst │ ├── directives.rst │ ├── domains.rst │ ├── field-lists.rst │ ├── index.rst │ └── roles.rst │ └── theming.rst ├── package-lock.json ├── package.json ├── pyproject.toml ├── pyrefly.toml ├── sphinx ├── __init__.py ├── __main__.py ├── _cli │ ├── __init__.py │ └── util │ │ ├── __init__.py │ │ ├── colour.py │ │ └── errors.py ├── addnodes.py ├── application.py ├── builders │ ├── __init__.py │ ├── _epub_base.py │ ├── changes.py │ ├── dirhtml.py │ ├── dummy.py │ ├── epub3.py │ ├── gettext.py │ ├── html │ │ ├── __init__.py │ │ ├── _assets.py │ │ └── _build_info.py │ ├── latex │ │ ├── __init__.py │ │ ├── constants.py │ │ ├── nodes.py │ │ ├── theming.py │ │ ├── transforms.py │ │ └── util.py │ ├── linkcheck.py │ ├── manpage.py │ ├── singlehtml.py │ ├── texinfo.py │ ├── text.py │ └── xml.py ├── cmd │ ├── __init__.py │ ├── build.py │ ├── make_mode.py │ └── quickstart.py ├── config.py ├── deprecation.py ├── directives │ ├── __init__.py │ ├── admonitions.py │ ├── code.py │ ├── other.py │ └── patches.py ├── domains │ ├── __init__.py │ ├── _domains_container.py │ ├── _index.py │ ├── c │ │ ├── __init__.py │ │ ├── _ast.py │ │ ├── _ids.py │ │ ├── _parser.py │ │ └── _symbol.py │ ├── changeset.py │ ├── citation.py │ ├── cpp │ │ ├── __init__.py │ │ ├── _ast.py │ │ ├── _ids.py │ │ ├── _parser.py │ │ └── _symbol.py │ ├── index.py │ ├── javascript.py │ ├── math.py │ ├── python │ │ ├── __init__.py │ │ ├── _annotations.py │ │ └── _object.py │ ├── rst.py │ └── std │ │ └── __init__.py ├── environment │ ├── __init__.py │ ├── adapters │ │ ├── __init__.py │ │ ├── asset.py │ │ ├── indexentries.py │ │ └── toctree.py │ └── collectors │ │ ├── __init__.py │ │ ├── asset.py │ │ ├── dependencies.py │ │ ├── metadata.py │ │ ├── title.py │ │ └── toctree.py ├── errors.py ├── events.py ├── ext │ ├── __init__.py │ ├── apidoc │ │ ├── __init__.py │ │ ├── __main__.py │ │ ├── _cli.py │ │ ├── _extension.py │ │ ├── _generate.py │ │ └── _shared.py │ ├── autodoc │ │ ├── __init__.py │ │ ├── directive.py │ │ ├── importer.py │ │ ├── mock.py │ │ ├── preserve_defaults.py │ │ ├── type_comment.py │ │ └── typehints.py │ ├── autosectionlabel.py │ ├── autosummary │ │ ├── __init__.py │ │ ├── generate.py │ │ └── templates │ │ │ └── autosummary │ │ │ ├── base.rst │ │ │ ├── class.rst │ │ │ └── module.rst │ ├── coverage.py │ ├── doctest.py │ ├── duration.py │ ├── extlinks.py │ ├── githubpages.py │ ├── graphviz.py │ ├── ifconfig.py │ ├── imgconverter.py │ ├── imgmath.py │ ├── inheritance_diagram.py │ ├── intersphinx │ │ ├── __init__.py │ │ ├── __main__.py │ │ ├── _cli.py │ │ ├── _load.py │ │ ├── _resolve.py │ │ └── _shared.py │ ├── linkcode.py │ ├── mathjax.py │ ├── napoleon │ │ ├── __init__.py │ │ └── docstring.py │ ├── todo.py │ └── viewcode.py ├── extension.py ├── highlighting.py ├── io.py ├── jinja2glue.py ├── locale │ ├── .tx │ │ └── config │ ├── __init__.py │ ├── ar │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── bg │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── bn │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── ca │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── ca@valencia │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── cak │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── cs │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── cy │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── da │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── de │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── de_DE │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── el │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── en_DE │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── en_FR │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── en_GB │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── en_HK │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── eo │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── es │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── es_CO │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── et │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── eu │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── fa │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── fi │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── fr │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── fr_FR │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── gl │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── he │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── hi │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── hi_IN │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── hr │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── hu │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── id │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── is │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── it │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── ja │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── ka │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── ko │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── lt │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── lv │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── mk │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── nb_NO │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── ne │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── nl │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── pl │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── pt │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── pt_BR │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── pt_PT │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── ro │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── ru │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── si │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── sk │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── sl │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── sphinx.pot │ ├── sq │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── sr │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── sr@latin │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── sr_RS │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── sv │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── ta │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── te │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── tr │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── uk_UA │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── ur │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── vi │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── yue │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── zh_CN │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── zh_HK │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ ├── zh_TW.Big5 │ │ └── LC_MESSAGES │ │ │ ├── sphinx.js │ │ │ ├── sphinx.mo │ │ │ └── sphinx.po │ └── zh_TW │ │ └── LC_MESSAGES │ │ ├── sphinx.js │ │ ├── sphinx.mo │ │ └── sphinx.po ├── parsers.py ├── project.py ├── py.typed ├── pycode │ ├── __init__.py │ ├── ast.py │ └── parser.py ├── pygments_styles.py ├── registry.py ├── roles.py ├── search │ ├── __init__.py │ ├── _stopwords │ │ ├── __init__.py │ │ ├── da.py │ │ ├── da.txt │ │ ├── de.py │ │ ├── de.txt │ │ ├── en.py │ │ ├── en.txt │ │ ├── es.py │ │ ├── es.txt │ │ ├── fi.py │ │ ├── fi.txt │ │ ├── fr.py │ │ ├── fr.txt │ │ ├── hu.py │ │ ├── hu.txt │ │ ├── it.py │ │ ├── it.txt │ │ ├── nl.py │ │ ├── nl.txt │ │ ├── no.py │ │ ├── no.txt │ │ ├── pt.py │ │ ├── pt.txt │ │ ├── ru.py │ │ ├── ru.txt │ │ ├── sv.py │ │ └── sv.txt │ ├── da.py │ ├── de.py │ ├── en.py │ ├── es.py │ ├── fi.py │ ├── fr.py │ ├── hu.py │ ├── it.py │ ├── ja.py │ ├── minified-js │ │ ├── README.rst │ │ ├── arabic-stemmer.js │ │ ├── armenian-stemmer.js │ │ ├── base-stemmer.js │ │ ├── basque-stemmer.js │ │ ├── catalan-stemmer.js │ │ ├── danish-stemmer.js │ │ ├── dutch-stemmer.js │ │ ├── dutch_porter-stemmer.js │ │ ├── english-stemmer.js │ │ ├── esperanto-stemmer.js │ │ ├── estonian-stemmer.js │ │ ├── finnish-stemmer.js │ │ ├── french-stemmer.js │ │ ├── german-stemmer.js │ │ ├── greek-stemmer.js │ │ ├── hindi-stemmer.js │ │ ├── hungarian-stemmer.js │ │ ├── indonesian-stemmer.js │ │ ├── irish-stemmer.js │ │ ├── italian-stemmer.js │ │ ├── lithuanian-stemmer.js │ │ ├── nepali-stemmer.js │ │ ├── norwegian-stemmer.js │ │ ├── porter-stemmer.js │ │ ├── portuguese-stemmer.js │ │ ├── romanian-stemmer.js │ │ ├── russian-stemmer.js │ │ ├── serbian-stemmer.js │ │ ├── spanish-stemmer.js │ │ ├── swedish-stemmer.js │ │ ├── tamil-stemmer.js │ │ ├── turkish-stemmer.js │ │ └── yiddish-stemmer.js │ ├── nl.py │ ├── no.py │ ├── non-minified-js │ │ ├── arabic-stemmer.js │ │ ├── armenian-stemmer.js │ │ ├── base-stemmer.js │ │ ├── basque-stemmer.js │ │ ├── catalan-stemmer.js │ │ ├── danish-stemmer.js │ │ ├── dutch-stemmer.js │ │ ├── dutch_porter-stemmer.js │ │ ├── english-stemmer.js │ │ ├── esperanto-stemmer.js │ │ ├── estonian-stemmer.js │ │ ├── finnish-stemmer.js │ │ ├── french-stemmer.js │ │ ├── german-stemmer.js │ │ ├── greek-stemmer.js │ │ ├── hindi-stemmer.js │ │ ├── hungarian-stemmer.js │ │ ├── indonesian-stemmer.js │ │ ├── irish-stemmer.js │ │ ├── italian-stemmer.js │ │ ├── lithuanian-stemmer.js │ │ ├── nepali-stemmer.js │ │ ├── norwegian-stemmer.js │ │ ├── porter-stemmer.js │ │ ├── portuguese-stemmer.js │ │ ├── romanian-stemmer.js │ │ ├── russian-stemmer.js │ │ ├── serbian-stemmer.js │ │ ├── spanish-stemmer.js │ │ ├── swedish-stemmer.js │ │ ├── tamil-stemmer.js │ │ ├── turkish-stemmer.js │ │ └── yiddish-stemmer.js │ ├── pt.py │ ├── ro.py │ ├── ru.py │ ├── sv.py │ ├── tr.py │ └── zh.py ├── templates │ ├── apidoc │ │ ├── module.rst.jinja │ │ ├── package.rst.jinja │ │ └── toc.rst.jinja │ ├── epub3 │ │ ├── container.xml │ │ ├── content.opf.jinja │ │ ├── mimetype │ │ ├── nav.xhtml.jinja │ │ └── toc.ncx.jinja │ ├── gettext │ │ └── message.pot.jinja │ ├── graphviz │ │ └── graphviz.css │ ├── htmlhelp │ │ ├── project.hhc │ │ ├── project.hhp │ │ └── project.stp │ ├── imgmath │ │ ├── preview.tex.jinja │ │ └── template.tex.jinja │ ├── latex │ │ ├── latex.tex.jinja │ │ ├── longtable.tex.jinja │ │ ├── sphinxmessages.sty.jinja │ │ ├── tabular.tex.jinja │ │ └── tabulary.tex.jinja │ ├── quickstart │ │ ├── Makefile.new.jinja │ │ ├── conf.py.jinja │ │ ├── make.bat.new.jinja │ │ └── root_doc.rst.jinja │ └── texinfo │ │ └── Makefile ├── testing │ ├── __init__.py │ ├── fixtures.py │ ├── path.py │ ├── restructuredtext.py │ └── util.py ├── texinputs │ ├── LICRcyr2utf8.xdy │ ├── LICRlatin2utf8.xdy │ ├── LatinRules.xdy │ ├── Makefile.jinja │ ├── latexmkjarc.jinja │ ├── latexmkrc.jinja │ ├── make.bat.jinja │ ├── python.ist │ ├── sphinx.sty │ ├── sphinx.xdy │ ├── sphinxhowto.cls │ ├── sphinxlatexadmonitions.sty │ ├── sphinxlatexcontainers.sty │ ├── sphinxlatexgraphics.sty │ ├── sphinxlatexindbibtoc.sty │ ├── sphinxlatexlists.sty │ ├── sphinxlatexliterals.sty │ ├── sphinxlatexnumfig.sty │ ├── sphinxlatexobjects.sty │ ├── sphinxlatexshadowbox.sty │ ├── sphinxlatexstyleheadings.sty │ ├── sphinxlatexstylepage.sty │ ├── sphinxlatexstyletext.sty │ ├── sphinxlatextables.sty │ ├── sphinxmanual.cls │ ├── sphinxoptionsgeometry.sty │ ├── sphinxoptionshyperref.sty │ ├── sphinxpackageboxes.sty │ ├── sphinxpackagecyrillic.sty │ ├── sphinxpackagefootnote.sty │ └── sphinxpackagesubstitutefont.sty ├── texinputs_win │ └── Makefile.jinja ├── themes │ ├── agogo │ │ ├── layout.html │ │ ├── static │ │ │ ├── agogo.css.jinja │ │ │ ├── bgfooter.png │ │ │ └── bgtop.png │ │ └── theme.toml │ ├── basic │ │ ├── changes │ │ │ ├── frameset.html │ │ │ ├── rstsource.html │ │ │ └── versionchanges.html │ │ ├── defindex.html │ │ ├── domainindex.html │ │ ├── genindex-single.html │ │ ├── genindex-split.html │ │ ├── genindex.html │ │ ├── globaltoc.html │ │ ├── layout.html │ │ ├── localtoc.html │ │ ├── opensearch.xml │ │ ├── page.html │ │ ├── relations.html │ │ ├── search.html │ │ ├── searchbox.html │ │ ├── searchfield.html │ │ ├── sourcelink.html │ │ ├── static │ │ │ ├── basic.css.jinja │ │ │ ├── doctools.js │ │ │ ├── documentation_options.js.jinja │ │ │ ├── file.png │ │ │ ├── language_data.js.jinja │ │ │ ├── minus.png │ │ │ ├── plus.png │ │ │ ├── searchtools.js │ │ │ └── sphinx_highlight.js │ │ └── theme.toml │ ├── bizstyle │ │ ├── layout.html │ │ ├── static │ │ │ ├── background_b01.png │ │ │ ├── bizstyle.css.jinja │ │ │ ├── bizstyle.js.jinja │ │ │ ├── css3-mediaqueries.js │ │ │ └── css3-mediaqueries_src.js │ │ └── theme.toml │ ├── classic │ │ ├── layout.html │ │ ├── static │ │ │ ├── classic.css.jinja │ │ │ └── sidebar.js.jinja │ │ └── theme.toml │ ├── default │ │ ├── static │ │ │ └── default.css │ │ └── theme.toml │ ├── epub │ │ ├── epub-cover.html │ │ ├── layout.html │ │ ├── static │ │ │ └── epub.css.jinja │ │ └── theme.toml │ ├── haiku │ │ ├── layout.html │ │ ├── static │ │ │ ├── alert_info_32.png │ │ │ ├── alert_warning_32.png │ │ │ ├── bg-page.png │ │ │ ├── bullet_orange.png │ │ │ └── haiku.css.jinja │ │ └── theme.toml │ ├── nature │ │ ├── static │ │ │ └── nature.css.jinja │ │ └── theme.toml │ ├── nonav │ │ ├── layout.html │ │ ├── static │ │ │ └── nonav.css.jinja │ │ └── theme.toml │ ├── pyramid │ │ ├── layout.html │ │ ├── static │ │ │ ├── dialog-note.png │ │ │ ├── dialog-seealso.png │ │ │ ├── dialog-todo.png │ │ │ ├── dialog-topic.png │ │ │ ├── dialog-warning.png │ │ │ ├── epub.css.jinja │ │ │ ├── footerbg.png │ │ │ ├── headerbg.png │ │ │ ├── ie6.css │ │ │ ├── middlebg.png │ │ │ ├── pyramid.css.jinja │ │ │ └── transparent.gif │ │ └── theme.toml │ ├── scrolls │ │ ├── artwork │ │ │ └── logo.svg │ │ ├── layout.html │ │ ├── static │ │ │ ├── darkmetal.png │ │ │ ├── headerbg.png │ │ │ ├── logo.png │ │ │ ├── metal.png │ │ │ ├── navigation.png │ │ │ ├── print.css │ │ │ ├── scrolls.css.jinja │ │ │ ├── theme_extras.js │ │ │ ├── watermark.png │ │ │ └── watermark_blur.png │ │ └── theme.toml │ ├── sphinxdoc │ │ ├── static │ │ │ ├── contents.png │ │ │ ├── navigation.png │ │ │ └── sphinxdoc.css.jinja │ │ └── theme.toml │ └── traditional │ │ ├── static │ │ └── traditional.css.jinja │ │ └── theme.toml ├── theming.py ├── transforms │ ├── __init__.py │ ├── compact_bullet_list.py │ ├── i18n.py │ ├── post_transforms │ │ ├── __init__.py │ │ ├── code.py │ │ └── images.py │ └── references.py ├── util │ ├── __init__.py │ ├── _files.py │ ├── _importer.py │ ├── _inventory_file_reader.py │ ├── _io.py │ ├── _lines.py │ ├── _pathlib.py │ ├── _serialise.py │ ├── _timestamps.py │ ├── _uri.py │ ├── build_phase.py │ ├── cfamily.py │ ├── console.py │ ├── display.py │ ├── docfields.py │ ├── docstrings.py │ ├── docutils.py │ ├── fileutil.py │ ├── http_date.py │ ├── i18n.py │ ├── images.py │ ├── index_entries.py │ ├── inspect.py │ ├── inventory.py │ ├── logging.py │ ├── matching.py │ ├── math.py │ ├── nodes.py │ ├── osutil.py │ ├── parallel.py │ ├── parsing.py │ ├── png.py │ ├── requests.py │ ├── rst.py │ ├── tags.py │ ├── template.py │ ├── texescape.py │ └── typing.py ├── versioning.py └── writers │ ├── __init__.py │ ├── html.py │ ├── html5.py │ ├── latex.py │ ├── manpage.py │ ├── texinfo.py │ ├── text.py │ └── xml.py ├── tests ├── __init__.py ├── certs │ └── cert.pem ├── conftest.py ├── js │ ├── documentation_options.js │ ├── fixtures │ │ ├── cpp │ │ │ └── searchindex.js │ │ ├── multiterm │ │ │ └── searchindex.js │ │ ├── partial │ │ │ └── searchindex.js │ │ └── titles │ │ │ └── searchindex.js │ ├── jasmine-browser.mjs │ ├── language_data.js │ ├── roots │ │ ├── cpp │ │ │ ├── conf.py │ │ │ └── index.rst │ │ ├── multiterm │ │ │ ├── conf.py │ │ │ └── index.rst │ │ ├── partial │ │ │ ├── conf.py │ │ │ └── index.rst │ │ └── titles │ │ │ ├── conf.py │ │ │ ├── index.rst │ │ │ ├── relevance.py │ │ │ └── relevance.rst │ ├── searchtools.spec.js │ └── sphinx_highlight.spec.js ├── roots │ ├── test-_blank │ │ ├── conf.py │ │ └── index.rst │ ├── test-add_enumerable_node │ │ ├── conf.py │ │ ├── enumerable_node.py │ │ ├── index.rst │ │ └── rimg.png │ ├── test-add_source_parser-conflicts-with-users-setting │ │ ├── conf.py │ │ └── source_parser.py │ ├── test-add_source_parser │ │ ├── conf.py │ │ └── source_parser.py │ ├── test-api-set-translator │ │ ├── conf.py │ │ ├── index.rst │ │ ├── nonext │ │ │ └── conf.py │ │ └── translator.py │ ├── test-basic │ │ ├── conf.py │ │ └── index.rst │ ├── test-build-html-theme-having-multiple-stylesheets │ │ ├── _themes │ │ │ └── mytheme │ │ │ │ ├── _static │ │ │ │ ├── extra.css │ │ │ │ └── mytheme.css │ │ │ │ └── theme.conf │ │ ├── conf.py │ │ └── index.rst │ ├── test-build-html-translator │ │ ├── conf.py │ │ └── index.rst │ ├── test-build-text │ │ ├── conf.py │ │ ├── doc1.txt │ │ ├── doc2.txt │ │ ├── index.txt │ │ ├── lineblock.txt │ │ ├── listitems.txt │ │ ├── maxwidth.txt │ │ ├── nonascii_maxwidth.txt │ │ ├── nonascii_table.txt │ │ ├── nonascii_title.txt │ │ ├── table.txt │ │ ├── table_colspan.txt │ │ ├── table_colspan_and_rowspan.txt │ │ ├── table_colspan_left.txt │ │ └── table_rowspan.txt │ ├── test-builder-dirhtml │ │ ├── bar.rst │ │ ├── conf.py │ │ ├── foo │ │ │ ├── foo_1.rst │ │ │ ├── foo_2.rst │ │ │ └── index.rst │ │ └── index.rst │ ├── test-builder-gettext-dont-rebuild-mo │ │ ├── bom.rst │ │ ├── conf.py │ │ ├── index.rst │ │ └── xx │ │ │ └── LC_MESSAGES │ │ │ └── bom.po │ ├── test-changes │ │ ├── base.rst │ │ ├── c-api.rst │ │ ├── conf.py │ │ ├── contents.rst │ │ └── library │ │ │ └── utils.rst │ ├── test-circular │ │ ├── conf.py │ │ ├── index.rst │ │ └── sub.rst │ ├── test-config │ │ └── conf.py │ ├── test-copyright-multiline │ │ ├── conf.py │ │ └── index.rst │ ├── test-default_role │ │ ├── conf.py │ │ ├── foo.rst │ │ └── index.rst │ ├── test-directive-code │ │ ├── caption.rst │ │ ├── classes.rst │ │ ├── conf.py │ │ ├── dedent.rst │ │ ├── emphasize.rst │ │ ├── empty.inc │ │ ├── error.inc │ │ ├── force.rst │ │ ├── highlight.rst │ │ ├── index.rst │ │ ├── linenos.rst │ │ ├── linenothreshold.rst │ │ ├── literal-diff.inc │ │ ├── literal-short.inc │ │ ├── literal.inc │ │ ├── namedblocks.rst │ │ ├── py-decorators.inc │ │ ├── py-decorators.rst │ │ ├── python.rst │ │ └── target.py │ ├── test-directive-csv-table │ │ ├── conf.py │ │ ├── example.csv │ │ └── subdir │ │ │ └── example.csv │ ├── test-directive-include │ │ ├── bar.txt │ │ ├── baz │ │ │ └── baz.rst │ │ ├── conf.py │ │ ├── foo.rst │ │ └── text.txt │ ├── test-directive-only │ │ ├── conf.py │ │ ├── index.rst │ │ └── only.rst │ ├── test-directives-admonition-collapse │ │ ├── conf.py │ │ └── index.rst │ ├── test-directives-raw │ │ ├── conf.py │ │ └── index.rst │ ├── test-docutilsconf │ │ ├── conf.py │ │ ├── docutils.conf │ │ └── index.rst │ ├── test-domain-c-c_maximum_signature_line_length │ │ ├── conf.py │ │ └── index.rst │ ├── test-domain-c-intersphinx │ │ ├── conf.py │ │ └── index.rst │ ├── test-domain-c │ │ ├── anon-dup-decl.rst │ │ ├── conf.py │ │ ├── field-role.rst │ │ ├── function_param_target.rst │ │ ├── index.rst │ │ ├── namespace.rst │ │ └── ns_lookup.rst │ ├── test-domain-cpp-cpp_maximum_signature_line_length │ │ ├── conf.py │ │ └── index.rst │ ├── test-domain-cpp-intersphinx │ │ ├── conf.py │ │ └── index.rst │ ├── test-domain-cpp │ │ ├── anon-dup-decl.rst │ │ ├── any-role.rst │ │ ├── backslash.rst │ │ ├── conf.py │ │ ├── field-role.rst │ │ ├── index.rst │ │ ├── lookup-key-overload.rst │ │ ├── multi-decl-lookup.rst │ │ ├── operator-lookup.rst │ │ ├── roles-targets-ok.rst │ │ ├── roles-targets-warn.rst │ │ ├── roles.rst │ │ ├── roles2.rst │ │ ├── semicolon.rst │ │ ├── warn-template-param-qualified-name.rst │ │ └── xref_consistency.rst │ ├── test-domain-js-javascript_maximum_signature_line_length │ │ ├── conf.py │ │ └── index.rst │ ├── test-domain-js │ │ ├── conf.py │ │ ├── index.rst │ │ ├── module.rst │ │ └── roles.rst │ ├── test-domain-py-python_maximum_signature_line_length │ │ ├── conf.py │ │ └── index.rst │ ├── test-domain-py-python_use_unqualified_type_names │ │ ├── conf.py │ │ └── index.rst │ ├── test-domain-py-xref-warning │ │ ├── conf.py │ │ └── index.rst │ ├── test-domain-py │ │ ├── abbr.rst │ │ ├── canonical.rst │ │ ├── conf.py │ │ ├── index.rst │ │ ├── module.rst │ │ ├── module_option.rst │ │ ├── roles.rst │ │ └── type_alias.rst │ ├── test-double-inheriting-theme │ │ ├── base_themes_dir │ │ │ ├── base_theme1 │ │ │ │ └── theme.conf │ │ │ └── base_theme2 │ │ │ │ └── theme.conf │ │ ├── conf.py │ │ └── index.rst │ ├── test-environment-record-dependencies │ │ ├── api.rst │ │ ├── conf.py │ │ ├── example_module.py │ │ └── index.rst │ ├── test-epub-anchor-id │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-apidoc-custom-templates │ │ ├── _templates │ │ │ ├── module.rst.jinja │ │ │ ├── module.rst_t │ │ │ └── package.rst_t │ │ └── mypackage │ │ │ ├── __init__.py │ │ │ └── mymodule.py │ ├── test-ext-apidoc-duplicates │ │ └── fish_licence │ │ │ ├── halibut.cpython-38-x86_64-linux-gnu.so │ │ │ ├── halibut.pyd │ │ │ ├── halibut.pyi │ │ │ └── halibut.pyx │ ├── test-ext-apidoc-pep420 │ │ └── a │ │ │ └── b │ │ │ ├── c │ │ │ ├── __init__.py │ │ │ └── d.py │ │ │ ├── e │ │ │ ├── __init__.py │ │ │ └── f.py │ │ │ └── x │ │ │ └── y.py │ ├── test-ext-apidoc-subpackage-in-toc │ │ └── parent │ │ │ ├── __init__.py │ │ │ └── child │ │ │ ├── __init__.py │ │ │ └── foo.py │ ├── test-ext-apidoc-toc │ │ └── mypackage │ │ │ ├── __init__.py │ │ │ ├── main.py │ │ │ ├── no_init │ │ │ └── foo.py │ │ │ ├── resource │ │ │ ├── __init__.py │ │ │ └── resource.txt │ │ │ └── something │ │ │ └── __init__.py │ ├── test-ext-apidoc-trailing-underscore │ │ └── package_ │ │ │ ├── __init__.py │ │ │ └── module_.py │ ├── test-ext-apidoc │ │ ├── conf.py │ │ ├── index.rst │ │ └── src │ │ │ ├── exclude_package.py │ │ │ └── my_package.py │ ├── test-ext-autodoc │ │ ├── autodoc_dummy_bar.py │ │ ├── autodoc_dummy_module.py │ │ ├── bug2437 │ │ │ ├── __init__.py │ │ │ └── autodoc_dummy_foo.py │ │ ├── circular_import │ │ │ ├── __init__.py │ │ │ ├── a.py │ │ │ ├── b.py │ │ │ └── c.py │ │ ├── conf.py │ │ ├── index.rst │ │ └── target │ │ │ ├── TYPE_CHECKING.py │ │ │ ├── __init__.py │ │ │ ├── _functions_to_import.py │ │ │ ├── abstractmethods.py │ │ │ ├── annotated.py │ │ │ ├── autoclass_content.py │ │ │ ├── autodoc_type_aliases.py │ │ │ ├── bound_method.py │ │ │ ├── cached_property.py │ │ │ ├── callable.py │ │ │ ├── canonical │ │ │ ├── __init__.py │ │ │ └── original.py │ │ │ ├── classes.py │ │ │ ├── coroutine.py │ │ │ ├── cython.pyx │ │ │ ├── decorator.py │ │ │ ├── descriptor.py │ │ │ ├── docstring_signature.py │ │ │ ├── empty_all.py │ │ │ ├── enums.py │ │ │ ├── final.py │ │ │ ├── functions.py │ │ │ ├── generic_class.py │ │ │ ├── genericalias.py │ │ │ ├── hide_value.py │ │ │ ├── imported_members.py │ │ │ ├── inheritance.py │ │ │ ├── inherited_annotations.py │ │ │ ├── instance_variable.py │ │ │ ├── literal.py │ │ │ ├── metadata.py │ │ │ ├── methods.py │ │ │ ├── module.py │ │ │ ├── name_conflict │ │ │ ├── __init__.py │ │ │ └── foo.py │ │ │ ├── name_mangling.py │ │ │ ├── need_mocks.py │ │ │ ├── overload.py │ │ │ ├── overload2.py │ │ │ ├── overload3.py │ │ │ ├── partialfunction.py │ │ │ ├── partialmethod.py │ │ │ ├── pep570.py │ │ │ ├── pep604.py │ │ │ ├── preserve_defaults.py │ │ │ ├── preserve_defaults_special_constructs.py │ │ │ ├── private.py │ │ │ ├── process_docstring.py │ │ │ ├── properties.py │ │ │ ├── singledispatch.py │ │ │ ├── singledispatchmethod.py │ │ │ ├── singledispatchmethod_classmethod.py │ │ │ ├── slots.py │ │ │ ├── sort_by_all.py │ │ │ ├── typed_vars.py │ │ │ ├── typehints.py │ │ │ ├── typevar.py │ │ │ ├── uninitialized_attributes.py │ │ │ └── wrappedfunction.py │ ├── test-ext-autosectionlabel-prefix-document │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-autosectionlabel │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-autosummary-ext │ │ ├── conf.py │ │ ├── dummy_module.py │ │ ├── index.rst │ │ ├── sphinx.rst │ │ └── underscore_module_.py │ ├── test-ext-autosummary-filename-map │ │ ├── autosummary_dummy_module.py │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-autosummary-import_cycle │ │ ├── conf.py │ │ ├── index.rst │ │ └── spam │ │ │ ├── __init__.py │ │ │ └── eggs.py │ ├── test-ext-autosummary-imported_members │ │ ├── autosummary_dummy_package │ │ │ ├── __init__.py │ │ │ └── autosummary_dummy_module.py │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-autosummary-mock_imports │ │ ├── conf.py │ │ ├── foo.py │ │ └── index.rst │ ├── test-ext-autosummary-module_all │ │ ├── autosummary_dummy_package_all │ │ │ ├── __init__.py │ │ │ ├── autosummary_dummy_module.py │ │ │ └── extra_dummy_module.py │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-autosummary-module_empty_all │ │ ├── autosummary_dummy_package_empty_all │ │ │ └── __init__.py │ │ ├── conf.py │ │ ├── index.rst │ │ └── templates │ │ │ └── autosummary │ │ │ └── module.rst │ ├── test-ext-autosummary-module_prefix │ │ ├── conf.py │ │ ├── index.rst │ │ └── pkg │ │ │ ├── __init__.py │ │ │ ├── mod0 │ │ │ └── __init__.py │ │ │ └── mod1 │ │ │ └── __init__.py │ ├── test-ext-autosummary-recursive │ │ ├── conf.py │ │ ├── index.rst │ │ ├── package │ │ │ ├── __init__.py │ │ │ ├── module.py │ │ │ ├── module_importfail.py │ │ │ └── package │ │ │ │ ├── __init__.py │ │ │ │ └── module.py │ │ └── package2 │ │ │ ├── __init__.py │ │ │ └── module.py │ ├── test-ext-autosummary-skip-member │ │ ├── conf.py │ │ ├── index.rst │ │ └── target.py │ ├── test-ext-autosummary-template │ │ ├── _templates │ │ │ └── empty.rst │ │ ├── conf.py │ │ ├── index.rst │ │ └── target.py │ ├── test-ext-autosummary │ │ ├── autosummary_class_module.py │ │ ├── autosummary_dummy_inherited_module.py │ │ ├── autosummary_dummy_module.py │ │ ├── autosummary_importfail.py │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-coverage │ │ ├── conf.py │ │ ├── grog │ │ │ ├── __init__.py │ │ │ ├── coverage_ignored.py │ │ │ ├── coverage_missing.py │ │ │ └── coverage_not_ignored.py │ │ └── index.rst │ ├── test-ext-doctest-fail-fast │ │ ├── conf.py │ │ └── fail-fast.txt │ ├── test-ext-doctest-skipif │ │ ├── conf.py │ │ └── skipif.txt │ ├── test-ext-doctest-with-autodoc │ │ ├── conf.py │ │ ├── dir │ │ │ ├── __init__.py │ │ │ ├── bar.py │ │ │ └── inner.rst │ │ ├── foo.py │ │ └── index.rst │ ├── test-ext-doctest │ │ ├── conf.py │ │ └── doctest.txt │ ├── test-ext-extlinks-hardcoded-urls-multiple-replacements │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-extlinks-hardcoded-urls │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-githubpages │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-graphviz │ │ ├── _static │ │ │ └── images │ │ │ │ └── test.svg │ │ ├── conf.py │ │ ├── graph.dot │ │ ├── graph.xx.dot │ │ └── index.rst │ ├── test-ext-ifconfig │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-imgconverter │ │ ├── conf.py │ │ ├── img.pdf │ │ ├── index.rst │ │ └── svgimg.svg │ ├── test-ext-imgmockconverter │ │ ├── 1 │ │ │ └── svgimg.svg │ │ ├── 2 │ │ │ └── svgimg.svg │ │ ├── conf.py │ │ ├── index.rst │ │ └── mocksvgconverter.py │ ├── test-ext-inheritance_diagram │ │ ├── conf.py │ │ ├── example │ │ │ ├── __init__.py │ │ │ └── sphinx.py │ │ ├── external │ │ │ └── other.py │ │ ├── index.rst │ │ ├── subdir │ │ │ ├── page1.rst │ │ │ └── page2.rst │ │ └── test.py │ ├── test-ext-intersphinx-cppdomain │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-intersphinx-role │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-math-compat │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-math-include │ │ ├── conf.py │ │ ├── included.rst │ │ ├── index.rst │ │ └── math.rst │ ├── test-ext-math-simple │ │ ├── conf.py │ │ └── index.rst │ ├── test-ext-math │ │ ├── conf.py │ │ ├── index.rst │ │ ├── math.rst │ │ ├── nomath.rst │ │ └── page.rst │ ├── test-ext-napoleon-paramtype │ │ ├── conf.py │ │ ├── index.rst │ │ └── pkg │ │ │ ├── __init__.py │ │ │ ├── bar.py │ │ │ └── foo.py │ ├── test-ext-napoleon │ │ ├── conf.py │ │ ├── index.rst │ │ ├── mypackage │ │ │ ├── __init__.py │ │ │ └── typehints.py │ │ └── typehints.rst │ ├── test-ext-todo │ │ ├── bar.rst │ │ ├── conf.py │ │ ├── foo.rst │ │ └── index.rst │ ├── test-ext-viewcode-find-package │ │ ├── conf.py │ │ ├── index.rst │ │ └── main_package │ │ │ ├── __init__.py │ │ │ └── subpackage │ │ │ ├── __init__.py │ │ │ └── _subpackage2 │ │ │ ├── __init__.py │ │ │ └── submodule.py │ ├── test-ext-viewcode-find │ │ ├── conf.py │ │ ├── index.rst │ │ └── not_a_package │ │ │ ├── __init__.py │ │ │ └── submodule.py │ ├── test-ext-viewcode │ │ ├── conf.py │ │ ├── index.rst │ │ ├── objects.rst │ │ └── spam │ │ │ ├── __init__.py │ │ │ ├── mod1.py │ │ │ ├── mod2.py │ │ │ └── mod3.py │ ├── test-extensions │ │ ├── conf.py │ │ ├── read_parallel.py │ │ ├── read_serial.py │ │ ├── write_parallel.py │ │ └── write_serial.py │ ├── test-footnotes │ │ ├── bar.rst │ │ ├── baz.rst │ │ ├── conf.py │ │ ├── index.rst │ │ └── rimg.png │ ├── test-gettext-custom-output-template │ │ ├── _templates │ │ │ └── message.pot.jinja │ │ ├── conf.py │ │ └── index.rst │ ├── test-gettext-template │ │ ├── _templates │ │ │ ├── template1.html │ │ │ └── template2.html │ │ ├── conf.py │ │ └── index.rst │ ├── test-glossary │ │ ├── conf.py │ │ └── index.rst │ ├── test-highlight_options │ │ ├── conf.py │ │ └── index.rst │ ├── test-html_assets │ │ ├── conf.py │ │ ├── extra │ │ │ ├── .htaccess │ │ │ ├── .htpasswd │ │ │ ├── API.html.jinja │ │ │ ├── css │ │ │ │ └── style.css │ │ │ ├── index.rst │ │ │ ├── rimg.png │ │ │ └── subdir │ │ │ │ ├── .htaccess │ │ │ │ └── .htpasswd │ │ ├── index.rst │ │ ├── static │ │ │ ├── .htaccess │ │ │ ├── .htpasswd │ │ │ ├── API.html.jinja │ │ │ ├── css │ │ │ │ └── style.css │ │ │ ├── index.rst │ │ │ ├── js │ │ │ │ └── custom.js │ │ │ ├── rimg.png │ │ │ └── subdir │ │ │ │ ├── .htaccess │ │ │ │ └── .htpasswd │ │ └── subdir │ │ │ ├── _build │ │ │ └── index.html │ │ │ └── background.png │ ├── test-html_entity │ │ ├── conf.py │ │ └── index.rst │ ├── test-html_file_checksum │ │ ├── conf.py │ │ ├── index.rst │ │ └── static │ │ │ ├── empty.js │ │ │ ├── script.js │ │ │ ├── stylesheet-a.css │ │ │ └── stylesheet-b.css │ ├── test-html_scaled_image_link │ │ ├── conf.py │ │ ├── img.png │ │ └── index.rst │ ├── test-html_signaturereturn_icon │ │ ├── conf.py │ │ └── index.rst │ ├── test-html_style │ │ ├── _static │ │ │ └── default.css │ │ ├── conf.py │ │ └── index.rst │ ├── test-image-escape │ │ ├── conf.py │ │ ├── img_#1.png │ │ └── index.rst │ ├── test-image-in-parsed-literal │ │ ├── conf.py │ │ ├── index.rst │ │ └── pic.png │ ├── test-image-in-section │ │ ├── conf.py │ │ ├── index.rst │ │ └── pic.png │ ├── test-images │ │ ├── conf.py │ │ ├── img.gif │ │ ├── img.ja.png │ │ ├── img.pdf │ │ ├── img.png │ │ ├── img.zh.png │ │ ├── index.rst │ │ ├── rimg.png │ │ ├── rimg.png.xx │ │ ├── rimg.xx.png │ │ ├── subdir │ │ │ ├── index.rst │ │ │ ├── rimg.png │ │ │ ├── rimg.xx.png │ │ │ ├── svgimg.pdf │ │ │ ├── svgimg.svg │ │ │ └── svgimg.xx.svg │ │ └── testimäge.png │ ├── test-index_on_title │ │ ├── conf.py │ │ └── contents.rst │ ├── test-inheritance │ │ ├── basic_diagram.rst │ │ ├── conf.py │ │ ├── diagram_module_w_2_top_classes.rst │ │ ├── diagram_w_1_top_class.rst │ │ ├── diagram_w_2_top_classes.rst │ │ ├── diagram_w_nested_classes.rst │ │ ├── diagram_w_parts.rst │ │ ├── dummy │ │ │ ├── __init__.py │ │ │ ├── test.py │ │ │ └── test_nested.py │ │ └── index.rst │ ├── test-intl │ │ ├── _templates │ │ │ └── contents.html │ │ ├── admonitions.txt │ │ ├── bom.txt │ │ ├── conf.py │ │ ├── definition_terms.txt │ │ ├── docfields.txt │ │ ├── external_links.txt │ │ ├── figure.txt │ │ ├── footnote.txt │ │ ├── glossary_terms.txt │ │ ├── glossary_terms_inconsistency.txt │ │ ├── i18n.png │ │ ├── img.png │ │ ├── index.txt │ │ ├── index_entries.txt │ │ ├── label_target.txt │ │ ├── literalblock.txt │ │ ├── markup.txt │ │ ├── noqa.txt │ │ ├── only.txt │ │ ├── raw.txt │ │ ├── refs.txt │ │ ├── refs_inconsistency.txt │ │ ├── refs_python_domain.txt │ │ ├── role_xref.txt │ │ ├── rubric.txt │ │ ├── section.txt │ │ ├── seealso.txt │ │ ├── subdir │ │ │ └── index.txt │ │ ├── table.txt │ │ ├── toctree.txt │ │ ├── topic.txt │ │ ├── translation_progress.txt │ │ ├── versionchange.txt │ │ ├── warnings.txt │ │ └── xx │ │ │ └── LC_MESSAGES │ │ │ ├── admonitions.po │ │ │ ├── bom.po │ │ │ ├── definition_terms.po │ │ │ ├── docfields.po │ │ │ ├── external_links.po │ │ │ ├── figure.po │ │ │ ├── footnote.po │ │ │ ├── glossary_terms.po │ │ │ ├── glossary_terms_inconsistency.po │ │ │ ├── index.po │ │ │ ├── index_entries.po │ │ │ ├── label_target.po │ │ │ ├── literalblock.po │ │ │ ├── markup.po │ │ │ ├── noqa.po │ │ │ ├── only.po │ │ │ ├── raw.po │ │ │ ├── refs.po │ │ │ ├── refs_inconsistency.po │ │ │ ├── refs_python_domain.po │ │ │ ├── role_xref.po │ │ │ ├── rubric.po │ │ │ ├── section.po │ │ │ ├── seealso.po │ │ │ ├── sphinx.po │ │ │ ├── table.po │ │ │ ├── toctree.po │ │ │ ├── topic.po │ │ │ ├── translation_progress.po │ │ │ ├── versionchange.po │ │ │ └── warnings.po │ ├── test-intl_substitution_definitions │ │ ├── conf.py │ │ ├── i18n.png │ │ ├── img.png │ │ ├── index.rst │ │ ├── prolog_epilog_substitution.rst │ │ ├── prolog_epilog_substitution_excluded.rst │ │ └── xx │ │ │ └── LC_MESSAGES │ │ │ └── prolog_epilog_substitution.po │ ├── test-keep_warnings │ │ ├── conf.py │ │ └── index.rst │ ├── test-latex-babel │ │ ├── bar.rst │ │ ├── conf.py │ │ ├── foo.rst │ │ └── index.rst │ ├── test-latex-container │ │ ├── conf.py │ │ └── index.rst │ ├── test-latex-contents-topic-sidebar │ │ ├── conf.py │ │ └── index.rst │ ├── test-latex-equations │ │ ├── conf.py │ │ ├── equations.rst │ │ └── expects │ │ │ └── latex-equations.tex │ ├── test-latex-figure-in-admonition │ │ ├── conf.py │ │ ├── img.png │ │ └── index.rst │ ├── test-latex-includegraphics │ │ ├── conf.py │ │ ├── img.png │ │ ├── index.rst │ │ ├── sphinx.png │ │ └── tall.png │ ├── test-latex-index │ │ ├── conf.py │ │ └── index.rst │ ├── test-latex-labels-before-module │ │ ├── automodule1.py │ │ ├── automodule2a.py │ │ ├── automodule2b.py │ │ ├── automodule3.py │ │ ├── conf.py │ │ └── index.rst │ ├── test-latex-labels │ │ ├── conf.py │ │ ├── index.rst │ │ └── otherdoc.rst │ ├── test-latex-numfig │ │ ├── conf.py │ │ ├── index.rst │ │ ├── indexhowto.rst │ │ └── indexmanual.rst │ ├── test-latex-table │ │ ├── _mytemplates │ │ │ └── latex │ │ │ │ ├── longtable.tex.jinja │ │ │ │ └── tabulary.tex_t │ │ ├── complex.rst │ │ ├── conf.py │ │ ├── expects │ │ │ ├── complex_spanning_cell.tex │ │ │ ├── gridtable.tex │ │ │ ├── gridtable_with_tabularcolumn.tex │ │ │ ├── longtable.tex │ │ │ ├── longtable_having_align.tex │ │ │ ├── longtable_having_caption.tex │ │ │ ├── longtable_having_problematic_cell.tex │ │ │ ├── longtable_having_stub_columns_and_problematic_cell.tex │ │ │ ├── longtable_having_verbatim.tex │ │ │ ├── longtable_having_widths.tex │ │ │ ├── longtable_having_widths_and_problematic_cell.tex │ │ │ ├── longtable_with_tabularcolumn.tex │ │ │ ├── simple_table.tex │ │ │ ├── table_having_caption.tex │ │ │ ├── table_having_problematic_cell.tex │ │ │ ├── table_having_stub_columns_and_problematic_cell.tex │ │ │ ├── table_having_threeparagraphs_cell_in_first_col.tex │ │ │ ├── table_having_verbatim.tex │ │ │ ├── table_having_widths.tex │ │ │ ├── table_having_widths_and_problematic_cell.tex │ │ │ ├── tabular_having_widths.tex │ │ │ ├── tabularcolumn.tex │ │ │ └── tabulary_having_widths.tex │ │ ├── index.rst │ │ ├── longtable.rst │ │ └── tabular.rst │ ├── test-latex-theme │ │ ├── conf.py │ │ ├── index.rst │ │ └── theme │ │ │ └── custom │ │ │ └── theme.conf │ ├── test-latex-title │ │ ├── conf.py │ │ └── index.rst │ ├── test-latex-unicode │ │ ├── conf.py │ │ └── index.rst │ ├── test-linkcheck-anchors-ignore-for-url │ │ ├── conf.py │ │ └── index.rst │ ├── test-linkcheck-anchors-ignore │ │ ├── conf.py │ │ └── index.rst │ ├── test-linkcheck-documents_exclude │ │ ├── br0ken_link.rst │ │ ├── broken_link.rst │ │ ├── conf.py │ │ └── index.rst │ ├── test-linkcheck-localserver-anchor │ │ ├── conf.py │ │ └── index.rst │ ├── test-linkcheck-localserver-https │ │ ├── conf.py │ │ └── index.rst │ ├── test-linkcheck-localserver-warn-redirects │ │ ├── conf.py │ │ └── index.rst │ ├── test-linkcheck-localserver │ │ ├── conf.py │ │ └── index.rst │ ├── test-linkcheck-raw-node │ │ └── conf.py │ ├── test-linkcheck-too-many-retries │ │ ├── conf.py │ │ └── index.rst │ ├── test-linkcheck │ │ ├── conf.py │ │ └── links.rst │ ├── test-local-logo │ │ ├── conf.py │ │ ├── images │ │ │ └── img.png │ │ └── index.rst │ ├── test-locale │ │ ├── locale1 │ │ │ ├── en │ │ │ │ └── LC_MESSAGES │ │ │ │ │ ├── myext.mo │ │ │ │ │ └── myext.po │ │ │ └── et │ │ │ │ └── LC_MESSAGES │ │ │ │ ├── myext.mo │ │ │ │ └── myext.po │ │ └── locale2 │ │ │ └── en │ │ │ └── LC_MESSAGES │ │ │ ├── myext.mo │ │ │ └── myext.po │ ├── test-manpage_url │ │ ├── conf.py │ │ └── index.rst │ ├── test-markup-citation │ │ ├── conf.py │ │ └── index.rst │ ├── test-markup-rubric │ │ ├── conf.py │ │ └── index.rst │ ├── test-maxlistdepth │ │ ├── conf.py │ │ └── index.rst │ ├── test-metadata │ │ ├── conf.py │ │ └── index.rst │ ├── test-need-escaped │ │ ├── bar.rst │ │ ├── baz.rst │ │ ├── conf.py │ │ ├── foo.rst │ │ ├── index.rst │ │ ├── quux.rst │ │ └── qux.rst │ ├── test-nested-enumerated-list │ │ ├── conf.py │ │ └── index.rst │ ├── test-nested-tables │ │ ├── conf.py │ │ └── index.rst │ ├── test-nitpicky-warnings │ │ ├── conf.py │ │ └── index.rst │ ├── test-numbered-circular │ │ ├── conf.py │ │ ├── index.rst │ │ └── sub.rst │ ├── test-numfig │ │ ├── bar.rst │ │ ├── baz.rst │ │ ├── conf.py │ │ ├── foo.rst │ │ ├── index.rst │ │ └── rimg.png │ ├── test-object-description-sections │ │ ├── conf.py │ │ └── index.rst │ ├── test-productionlist │ │ ├── Bare.rst │ │ ├── Dup1.rst │ │ ├── Dup2.rst │ │ ├── LineContinuation.rst │ │ ├── P1.rst │ │ ├── P2.rst │ │ ├── conf.py │ │ ├── firstLineRule.rst │ │ └── index.rst │ ├── test-prolog │ │ ├── conf.py │ │ ├── index.rst │ │ ├── markdown.md │ │ ├── prolog_markdown_parser.py │ │ └── restructuredtext.rst │ ├── test-pycode │ │ └── cp_1251_coded.py │ ├── test-reST-code-block │ │ ├── conf.py │ │ └── index.rst │ ├── test-reST-code-role │ │ ├── conf.py │ │ └── index.rst │ ├── test-refonly_bullet_list │ │ ├── conf.py │ │ └── index.rst │ ├── test-remote-logo │ │ ├── conf.py │ │ └── index.rst │ ├── test-roles-download │ │ ├── another │ │ │ └── dummy.dat │ │ ├── conf.py │ │ ├── dummy.dat │ │ └── index.rst │ ├── test-root │ │ ├── Makefile │ │ ├── _templates │ │ │ ├── contentssb.html │ │ │ ├── customsb.html │ │ │ └── layout.html │ │ ├── autodoc.txt │ │ ├── autodoc_target.py │ │ ├── bom.txt │ │ ├── conf.py │ │ ├── extapi.txt │ │ ├── extensions.txt │ │ ├── file_with_special_#_chars.xyz │ │ ├── footnote.txt │ │ ├── images.txt │ │ ├── img.foo.png │ │ ├── img.gif │ │ ├── img.pdf │ │ ├── img.png │ │ ├── includes.txt │ │ ├── index.txt │ │ ├── lists.txt │ │ ├── literal.inc │ │ ├── literal_orig.inc │ │ ├── markup.txt │ │ ├── math.txt │ │ ├── objects.txt │ │ ├── otherext.foo │ │ ├── parsermod.py │ │ ├── quotes.inc │ │ ├── rimg.png │ │ ├── special │ │ │ ├── api.h │ │ │ └── code.py │ │ ├── subdir │ │ │ ├── excluded.txt │ │ │ ├── images.txt │ │ │ ├── img.png │ │ │ ├── include.inc │ │ │ ├── includes.txt │ │ │ └── simg.png │ │ ├── svgimg.pdf │ │ ├── svgimg.svg │ │ ├── tabs.inc │ │ ├── test.inc │ │ └── wrongenc.inc │ ├── test-search │ │ ├── conf.py │ │ ├── index.rst │ │ ├── nosearch.rst │ │ └── tocitem.rst │ ├── test-smartquotes │ │ ├── conf.py │ │ ├── index.rst │ │ └── literals.rst │ ├── test-stylesheets │ │ ├── _templates │ │ │ └── layout.html │ │ ├── conf.py │ │ └── index.rst │ ├── test-templating │ │ ├── _templates │ │ │ ├── autosummary │ │ │ │ └── class.rst │ │ │ └── layout.html │ │ ├── autosummary_templating.txt │ │ ├── conf.py │ │ └── index.txt │ ├── test-theming │ │ ├── child.zip │ │ ├── conf.py │ │ ├── index.rst │ │ ├── parent.zip │ │ ├── test_theme │ │ │ ├── __init__.py │ │ │ ├── staticfiles │ │ │ │ ├── layout.html │ │ │ │ ├── static │ │ │ │ │ ├── legacytmpl.html_t │ │ │ │ │ ├── staticimg.png │ │ │ │ │ └── statictmpl.html.jinja │ │ │ │ └── theme.conf │ │ │ └── test-theme │ │ │ │ └── theme.conf │ │ └── ziptheme.zip │ ├── test-tocdepth │ │ ├── bar.rst │ │ ├── baz.rst │ │ ├── conf.py │ │ ├── foo.rst │ │ └── index.rst │ ├── test-toctree-domain-objects │ │ ├── conf.py │ │ ├── document_scoping.rst │ │ ├── domains.rst │ │ └── index.rst │ ├── test-toctree-duplicated │ │ ├── conf.py │ │ ├── foo.rst │ │ └── index.rst │ ├── test-toctree-empty │ │ ├── _templates │ │ │ └── localtoc.html │ │ ├── conf.py │ │ └── index.rst │ ├── test-toctree-glob │ │ ├── bar │ │ │ ├── bar_1.rst │ │ │ ├── bar_2.rst │ │ │ ├── bar_3.rst │ │ │ ├── bar_4 │ │ │ │ └── index.rst │ │ │ └── index.rst │ │ ├── baz.rst │ │ ├── conf.py │ │ ├── foo.rst │ │ ├── index.rst │ │ ├── quux.rst │ │ └── qux │ │ │ ├── index.rst │ │ │ ├── qux_1.rst │ │ │ └── qux_2.rst │ ├── test-toctree-index │ │ ├── conf.py │ │ ├── foo.rst │ │ └── index.rst │ ├── test-toctree-maxdepth │ │ ├── bar.rst │ │ ├── baz.rst │ │ ├── conf.py │ │ ├── foo.rst │ │ ├── index.rst │ │ └── qux.rst │ ├── test-toctree-multiple-parents │ │ ├── alpha.rst │ │ ├── bravo.rst │ │ ├── charlie.rst │ │ ├── conf.py │ │ ├── delta.rst │ │ ├── index.rst │ │ └── relation_graph.txt │ ├── test-toctree │ │ ├── bar.rst │ │ ├── baz.rst │ │ ├── conf.py │ │ ├── foo.rst │ │ ├── index.rst │ │ ├── quux.rst │ │ ├── qux.rst │ │ └── tocdepth.rst │ ├── test-transforms-post_transforms-keyboard │ │ ├── conf.py │ │ └── index.rst │ ├── test-transforms-post_transforms-missing-reference │ │ ├── conf.py │ │ └── index.rst │ ├── test-trim_doctest_flags │ │ ├── conf.py │ │ └── index.rst │ ├── test-util-copyasset_overwrite │ │ ├── conf.py │ │ ├── index.rst │ │ ├── myext.py │ │ ├── myext_static │ │ │ └── custom-styles.css │ │ └── user_static │ │ │ └── custom-styles.css │ ├── test-versioning │ │ ├── added.txt │ │ ├── conf.py │ │ ├── deleted.txt │ │ ├── deleted_end.txt │ │ ├── index.txt │ │ ├── insert.txt │ │ ├── insert_beginning.txt │ │ ├── insert_similar.txt │ │ ├── modified.txt │ │ └── original.txt │ └── test-warnings │ │ ├── autodoc_fodder.py │ │ ├── conf.py │ │ ├── index.rst │ │ ├── svgimg.pdf │ │ ├── svgimg.svg │ │ ├── undecodable.rst │ │ └── wrongenc.inc ├── test__cli │ ├── __init__.py │ └── test__cli_util_errors.py ├── test_addnodes.py ├── test_application.py ├── test_builders │ ├── __init__.py │ ├── conftest.py │ ├── test_build.py │ ├── test_build_all.py │ ├── test_build_changes.py │ ├── test_build_dirhtml.py │ ├── test_build_epub.py │ ├── test_build_gettext.py │ ├── test_build_html.py │ ├── test_build_html_5_output.py │ ├── test_build_html_assets.py │ ├── test_build_html_code.py │ ├── test_build_html_copyright.py │ ├── test_build_html_download.py │ ├── test_build_html_highlight.py │ ├── test_build_html_image.py │ ├── test_build_html_maths.py │ ├── test_build_html_numfig.py │ ├── test_build_html_tocdepth.py │ ├── test_build_html_toctree.py │ ├── test_build_latex.py │ ├── test_build_linkcheck.py │ ├── test_build_manpage.py │ ├── test_build_texinfo.py │ ├── test_build_text.py │ ├── test_build_warnings.py │ ├── test_incremental_reading.py │ ├── xpath_data.py │ ├── xpath_html_util.py │ └── xpath_util.py ├── test_command_line.py ├── test_config │ ├── __init__.py │ ├── test_config.py │ └── test_copyright.py ├── test_directives │ ├── __init__.py │ ├── test_directive_code.py │ ├── test_directive_object_description.py │ ├── test_directive_only.py │ ├── test_directive_option.py │ ├── test_directive_other.py │ ├── test_directive_patch.py │ ├── test_directive_productionlist.py │ └── test_directives_no_typesetting.py ├── test_domains │ ├── __init__.py │ ├── test_domain_c.py │ ├── test_domain_cpp.py │ ├── test_domain_js.py │ ├── test_domain_py.py │ ├── test_domain_py_canonical.py │ ├── test_domain_py_fields.py │ ├── test_domain_py_pyfunction.py │ ├── test_domain_py_pyobject.py │ ├── test_domain_rst.py │ └── test_domain_std.py ├── test_environment │ ├── __init__.py │ ├── test_environment.py │ ├── test_environment_indexentries.py │ ├── test_environment_record_dependencies.py │ └── test_environment_toctree.py ├── test_errors.py ├── test_events.py ├── test_extensions │ ├── __init__.py │ ├── autodoc_util.py │ ├── ext_napoleon_pep526_data_google.py │ ├── ext_napoleon_pep526_data_numpy.py │ ├── test_ext_apidoc.py │ ├── test_ext_autodoc.py │ ├── test_ext_autodoc_autoattribute.py │ ├── test_ext_autodoc_autoclass.py │ ├── test_ext_autodoc_autodata.py │ ├── test_ext_autodoc_autofunction.py │ ├── test_ext_autodoc_automodule.py │ ├── test_ext_autodoc_autoproperty.py │ ├── test_ext_autodoc_configs.py │ ├── test_ext_autodoc_events.py │ ├── test_ext_autodoc_importer.py │ ├── test_ext_autodoc_mock.py │ ├── test_ext_autodoc_preserve_defaults.py │ ├── test_ext_autodoc_private_members.py │ ├── test_ext_autosectionlabel.py │ ├── test_ext_autosummary.py │ ├── test_ext_autosummary_imports.py │ ├── test_ext_coverage.py │ ├── test_ext_doctest.py │ ├── test_ext_duration.py │ ├── test_ext_extlinks.py │ ├── test_ext_githubpages.py │ ├── test_ext_graphviz.py │ ├── test_ext_ifconfig.py │ ├── test_ext_imgconverter.py │ ├── test_ext_imgmockconverter.py │ ├── test_ext_inheritance_diagram.py │ ├── test_ext_intersphinx.py │ ├── test_ext_intersphinx_cache.py │ ├── test_ext_math.py │ ├── test_ext_napoleon.py │ ├── test_ext_napoleon_docstring.py │ ├── test_ext_todo.py │ ├── test_ext_viewcode.py │ └── test_extension.py ├── test_highlighting.py ├── test_intl │ ├── __init__.py │ ├── test_catalogs.py │ ├── test_intl.py │ └── test_locale.py ├── test_markup │ ├── __init__.py │ ├── test_markup.py │ ├── test_metadata.py │ ├── test_parser.py │ └── test_smartquotes.py ├── test_project.py ├── test_pycode │ ├── __init__.py │ ├── test_pycode.py │ ├── test_pycode_ast.py │ └── test_pycode_parser.py ├── test_quickstart.py ├── test_roles.py ├── test_search.py ├── test_theming │ ├── __init__.py │ ├── test_html_theme.py │ ├── test_templating.py │ ├── test_theming.py │ ├── theme.conf │ └── theme.toml ├── test_transforms │ ├── __init__.py │ ├── test_transforms_move_module_targets.py │ ├── test_transforms_post_transforms.py │ ├── test_transforms_post_transforms_code.py │ ├── test_transforms_post_transforms_images.py │ ├── test_transforms_reorder_nodes.py │ └── test_unreferenced_footnotes.py ├── test_util │ ├── __init__.py │ ├── intersphinx_data.py │ ├── test_util.py │ ├── test_util_display.py │ ├── test_util_docstrings.py │ ├── test_util_docutils.py │ ├── test_util_docutils_sphinx_directive.py │ ├── test_util_fileutil.py │ ├── test_util_i18n.py │ ├── test_util_images.py │ ├── test_util_importer.py │ ├── test_util_inspect.py │ ├── test_util_inventory.py │ ├── test_util_lines.py │ ├── test_util_logging.py │ ├── test_util_matching.py │ ├── test_util_nodes.py │ ├── test_util_rst.py │ ├── test_util_template.py │ ├── test_util_typing.py │ ├── test_util_uri.py │ └── typing_test_data.py ├── test_versioning.py ├── test_writers │ ├── __init__.py │ ├── test_api_translator.py │ ├── test_docutilsconf.py │ └── test_writer_latex.py └── utils.py ├── tox.ini └── utils ├── CHANGES_template.rst ├── __init__.py ├── babel_runner.py ├── bump_docker.py ├── bump_version.py ├── convert_attestations.py ├── generate_js_fixtures.py ├── generate_snowball.py └── release-checklist.rst /.codecov.yml: -------------------------------------------------------------------------------- 1 | comment: false 2 | coverage: 3 | status: 4 | project: 5 | default: 6 | enabled: no 7 | patch: 8 | default: 9 | enabled: no 10 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "github-actions" 4 | directory: "/" 5 | schedule: 6 | interval: "daily" 7 | - package-ecosystem: "pip" 8 | directory: "/" 9 | schedule: 10 | interval: "daily" 11 | -------------------------------------------------------------------------------- /.prettierrc.toml: -------------------------------------------------------------------------------- 1 | # https://prettier.io/docs/options 2 | experimentalOperatorPosition = "start" 3 | -------------------------------------------------------------------------------- /doc/_static/Makefile: -------------------------------------------------------------------------------- 1 | translation.png: translation.puml 2 | plantuml -tpng $< 3 | translation.svg: translation.puml 4 | plantuml -tsvg $< 5 | clean: 6 | rm -f translation.png translation.svg 7 | -------------------------------------------------------------------------------- /doc/_static/bookcover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/bookcover.png -------------------------------------------------------------------------------- /doc/_static/jupyter-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/jupyter-logo.png -------------------------------------------------------------------------------- /doc/_static/linux-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/linux-logo.png -------------------------------------------------------------------------------- /doc/_static/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/python-logo.png -------------------------------------------------------------------------------- /doc/_static/sphinx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/sphinx.png -------------------------------------------------------------------------------- /doc/_static/themes/agogo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/agogo.png -------------------------------------------------------------------------------- /doc/_static/themes/alabaster.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/alabaster.png -------------------------------------------------------------------------------- /doc/_static/themes/bizstyle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/bizstyle.png -------------------------------------------------------------------------------- /doc/_static/themes/classic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/classic.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/agogo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/agogo.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/alabaster.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/alabaster.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/bizstyle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/bizstyle.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/classic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/classic.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/haiku.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/haiku.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/nature.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/nature.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/pyramid.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/pyramid.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/scrolls.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/scrolls.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/sphinx_rtd_theme.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/sphinx_rtd_theme.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/sphinxdoc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/sphinxdoc.png -------------------------------------------------------------------------------- /doc/_static/themes/fullsize/traditional.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/fullsize/traditional.png -------------------------------------------------------------------------------- /doc/_static/themes/haiku.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/haiku.png -------------------------------------------------------------------------------- /doc/_static/themes/nature.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/nature.png -------------------------------------------------------------------------------- /doc/_static/themes/pyramid.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/pyramid.png -------------------------------------------------------------------------------- /doc/_static/themes/scrolls.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/scrolls.png -------------------------------------------------------------------------------- /doc/_static/themes/sphinx_rtd_theme.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/sphinx_rtd_theme.png -------------------------------------------------------------------------------- /doc/_static/themes/sphinxdoc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/sphinxdoc.png -------------------------------------------------------------------------------- /doc/_static/themes/traditional.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/themes/traditional.png -------------------------------------------------------------------------------- /doc/_static/translation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/translation.png -------------------------------------------------------------------------------- /doc/_static/tutorial/lumache-autosummary.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/tutorial/lumache-autosummary.png -------------------------------------------------------------------------------- /doc/_static/tutorial/lumache-first-light.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/tutorial/lumache-first-light.png -------------------------------------------------------------------------------- /doc/_static/tutorial/lumache-furo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/tutorial/lumache-furo.png -------------------------------------------------------------------------------- /doc/_static/tutorial/lumache-py-function-full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/tutorial/lumache-py-function-full.png -------------------------------------------------------------------------------- /doc/_static/tutorial/lumache-py-function.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/doc/_static/tutorial/lumache-py-function.png -------------------------------------------------------------------------------- /doc/_themes/sphinx13/theme.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = "basic" 3 | pygments_style = { default = "default" } 4 | sidebars = [] 5 | -------------------------------------------------------------------------------- /doc/authors.rst: -------------------------------------------------------------------------------- 1 | :tocdepth: 2 2 | 3 | .. _authors: 4 | 5 | ============== 6 | Sphinx authors 7 | ============== 8 | 9 | .. include:: ../AUTHORS.rst 10 | -------------------------------------------------------------------------------- /doc/development/howtos/index.rst: -------------------------------------------------------------------------------- 1 | How-tos 2 | ======= 3 | 4 | .. toctree:: 5 | :maxdepth: 1 6 | 7 | setup_extension 8 | builders 9 | -------------------------------------------------------------------------------- /doc/development/tutorials/index.rst: -------------------------------------------------------------------------------- 1 | .. _extension-tutorials-index: 2 | 3 | Tutorials 4 | ========= 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | 9 | extending_syntax 10 | extending_build 11 | adding_domain 12 | autodoc_ext 13 | -------------------------------------------------------------------------------- /doc/examples.rst: -------------------------------------------------------------------------------- 1 | :tocdepth: 2 2 | 3 | .. _examples: 4 | 5 | .. include:: ../EXAMPLES.rst 6 | -------------------------------------------------------------------------------- /doc/extdev/collectorapi.rst: -------------------------------------------------------------------------------- 1 | .. _collector-api: 2 | 3 | Environment Collector API 4 | ------------------------- 5 | 6 | .. module:: sphinx.environment.collectors 7 | 8 | .. autoclass:: EnvironmentCollector 9 | :members: 10 | -------------------------------------------------------------------------------- /doc/extdev/projectapi.rst: -------------------------------------------------------------------------------- 1 | .. _project-api: 2 | 3 | Project API 4 | =========== 5 | 6 | .. currentmodule:: sphinx.project 7 | 8 | .. autoclass:: Project 9 | :members: 10 | -------------------------------------------------------------------------------- /doc/internals/code-of-conduct.rst: -------------------------------------------------------------------------------- 1 | :tocdepth: 2 2 | 3 | .. _code_of_conduct: 4 | 5 | .. include:: ../../CODE_OF_CONDUCT.rst 6 | -------------------------------------------------------------------------------- /sphinx/__main__.py: -------------------------------------------------------------------------------- 1 | """The Sphinx documentation toolchain.""" 2 | 3 | from __future__ import annotations 4 | 5 | import sys 6 | 7 | from sphinx.cmd.build import main 8 | 9 | raise SystemExit(main(sys.argv[1:])) 10 | -------------------------------------------------------------------------------- /sphinx/_cli/util/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/_cli/util/__init__.py -------------------------------------------------------------------------------- /sphinx/cmd/__init__.py: -------------------------------------------------------------------------------- 1 | """Modules for command line executables.""" 2 | -------------------------------------------------------------------------------- /sphinx/environment/adapters/__init__.py: -------------------------------------------------------------------------------- 1 | """Sphinx environment adapters""" 2 | -------------------------------------------------------------------------------- /sphinx/ext/__init__.py: -------------------------------------------------------------------------------- 1 | """Contains Sphinx features not activated by default.""" 2 | -------------------------------------------------------------------------------- /sphinx/ext/apidoc/__main__.py: -------------------------------------------------------------------------------- 1 | """Command-line interface for the apidoc extension.""" 2 | 3 | from __future__ import annotations 4 | 5 | import sys 6 | 7 | from sphinx.ext.apidoc._cli import main 8 | 9 | raise SystemExit(main(sys.argv[1:])) 10 | -------------------------------------------------------------------------------- /sphinx/ext/autosummary/templates/autosummary/base.rst: -------------------------------------------------------------------------------- 1 | {{ fullname | escape | underline}} 2 | 3 | .. currentmodule:: {{ module }} 4 | 5 | .. auto{{ objtype }}:: {{ objname }} 6 | -------------------------------------------------------------------------------- /sphinx/locale/.tx/config: -------------------------------------------------------------------------------- 1 | [main] 2 | host = https://www.transifex.com 3 | 4 | [o:sphinx-doc:p:sphinx-1:r:sphinx-pot] 5 | file_filter = /LC_MESSAGES/sphinx.po 6 | source_file = sphinx.pot 7 | source_lang = en 8 | -------------------------------------------------------------------------------- /sphinx/locale/ar/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ar/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/bg/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/bg/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/bn/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/bn/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/ca/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ca/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/ca@valencia/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ca@valencia/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/cak/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/cak/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/cs/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/cs/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/cy/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/cy/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/da/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/da/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/de/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/de/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/de_DE/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/de_DE/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/el/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/el/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/en_DE/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/en_DE/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/en_FR/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/en_FR/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/en_GB/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/en_GB/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/en_HK/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/en_HK/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/eo/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/eo/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/es/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/es/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/es_CO/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/es_CO/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/et/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/et/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/eu/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/eu/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/fa/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/fa/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/fi/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/fi/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/fr/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/fr/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/fr_FR/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/fr_FR/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/gl/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/gl/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/he/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/he/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/hi/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/hi/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/hi_IN/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/hi_IN/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/hr/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/hr/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/hu/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/hu/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/id/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/id/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/is/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/is/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/it/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/it/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/ja/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ja/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/ka/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ka/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/ko/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ko/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/lt/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/lt/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/lv/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/lv/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/mk/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/mk/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/nb_NO/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/nb_NO/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/ne/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ne/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/nl/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/nl/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/pl/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/pl/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/pt/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/pt/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/pt_BR/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/pt_BR/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/pt_PT/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/pt_PT/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/ro/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ro/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/ru/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ru/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/si/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/si/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/sk/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/sk/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/sl/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/sl/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/sq/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/sq/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/sr/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/sr/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/sr@latin/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/sr@latin/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/sr_RS/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/sr_RS/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/sv/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/sv/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/ta/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ta/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/te/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/te/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/tr/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/tr/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/uk_UA/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/uk_UA/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/ur/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/ur/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/vi/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/vi/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/yue/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/yue/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/zh_CN/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/zh_CN/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/zh_HK/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/zh_HK/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/zh_TW.Big5/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/zh_TW.Big5/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/locale/zh_TW/LC_MESSAGES/sphinx.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/locale/zh_TW/LC_MESSAGES/sphinx.mo -------------------------------------------------------------------------------- /sphinx/py.typed: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/py.typed -------------------------------------------------------------------------------- /sphinx/search/_stopwords/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/search/_stopwords/__init__.py -------------------------------------------------------------------------------- /sphinx/templates/apidoc/module.rst.jinja: -------------------------------------------------------------------------------- 1 | {%- if show_headings %} 2 | {{- [basename, "module"] | join(' ') | e | heading }} 3 | 4 | {% endif -%} 5 | .. automodule:: {{ qualname }} 6 | {%- for option in automodule_options %} 7 | :{{ option }}: 8 | {%- endfor %} 9 | 10 | -------------------------------------------------------------------------------- /sphinx/templates/apidoc/toc.rst.jinja: -------------------------------------------------------------------------------- 1 | {{ header | heading }} 2 | 3 | .. toctree:: 4 | :maxdepth: {{ maxdepth }} 5 | {% for docname in docnames %} 6 | {{ docname }} 7 | {%- endfor %} 8 | 9 | -------------------------------------------------------------------------------- /sphinx/templates/epub3/mimetype: -------------------------------------------------------------------------------- 1 | application/epub+zip -------------------------------------------------------------------------------- /sphinx/templates/graphviz/graphviz.css: -------------------------------------------------------------------------------- 1 | /* 2 | * Sphinx stylesheet -- graphviz extension. 3 | */ 4 | 5 | img.graphviz { 6 | border: 0; 7 | max-width: 100%; 8 | } 9 | 10 | object.graphviz { 11 | max-width: 100%; 12 | } 13 | -------------------------------------------------------------------------------- /sphinx/testing/__init__.py: -------------------------------------------------------------------------------- 1 | """Sphinx test utilities 2 | 3 | You can require sphinx.testing pytest fixtures in a test module or a conftest 4 | file like this: 5 | 6 | pytest_plugins = 'sphinx.testing.fixtures' 7 | """ 8 | -------------------------------------------------------------------------------- /sphinx/texinputs/LatinRules.xdy: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/texinputs/LatinRules.xdy -------------------------------------------------------------------------------- /sphinx/themes/agogo/static/bgfooter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/agogo/static/bgfooter.png -------------------------------------------------------------------------------- /sphinx/themes/agogo/static/bgtop.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/agogo/static/bgtop.png -------------------------------------------------------------------------------- /sphinx/themes/basic/localtoc.html: -------------------------------------------------------------------------------- 1 | {# Sphinx sidebar template: local table of contents. #} 2 | {%- if display_toc %} 3 |
4 |

{{ _('Table of Contents') }}

5 | {{ toc }} 6 |
7 | {%- endif %} 8 | -------------------------------------------------------------------------------- /sphinx/themes/basic/page.html: -------------------------------------------------------------------------------- 1 | {# Master template for simple pages. #} 2 | {%- extends "layout.html" %} 3 | {% block body %} 4 | {{ body }} 5 | {% endblock %} 6 | -------------------------------------------------------------------------------- /sphinx/themes/basic/static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/basic/static/file.png -------------------------------------------------------------------------------- /sphinx/themes/basic/static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/basic/static/minus.png -------------------------------------------------------------------------------- /sphinx/themes/basic/static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/basic/static/plus.png -------------------------------------------------------------------------------- /sphinx/themes/bizstyle/static/background_b01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/bizstyle/static/background_b01.png -------------------------------------------------------------------------------- /sphinx/themes/bizstyle/theme.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = "basic" 3 | stylesheets = [ 4 | "bizstyle.css", 5 | ] 6 | pygments_style = { default = "friendly" } 7 | 8 | [options] 9 | rightsidebar = "false" 10 | sidebarwidth = "210" 11 | 12 | maincolor = "#336699" 13 | -------------------------------------------------------------------------------- /sphinx/themes/default/static/default.css: -------------------------------------------------------------------------------- 1 | @import url("classic.css"); 2 | -------------------------------------------------------------------------------- /sphinx/themes/default/theme.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = "classic" 3 | -------------------------------------------------------------------------------- /sphinx/themes/epub/theme.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = "basic" 3 | stylesheets = [ 4 | "epub.css", 5 | ] 6 | pygments_style = { default = "none" } 7 | 8 | [options] 9 | relbar1 = "true" 10 | footer = "true" 11 | -------------------------------------------------------------------------------- /sphinx/themes/haiku/static/alert_info_32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/haiku/static/alert_info_32.png -------------------------------------------------------------------------------- /sphinx/themes/haiku/static/alert_warning_32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/haiku/static/alert_warning_32.png -------------------------------------------------------------------------------- /sphinx/themes/haiku/static/bg-page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/haiku/static/bg-page.png -------------------------------------------------------------------------------- /sphinx/themes/haiku/static/bullet_orange.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/haiku/static/bullet_orange.png -------------------------------------------------------------------------------- /sphinx/themes/nature/theme.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = "basic" 3 | stylesheets = [ 4 | "nature.css", 5 | ] 6 | pygments_style = { default = "tango" } 7 | -------------------------------------------------------------------------------- /sphinx/themes/nonav/theme.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = "basic" 3 | stylesheets = [ 4 | "nonav.css", 5 | ] 6 | pygments_style = { default = "none" } 7 | 8 | [options] 9 | relbar1 = "true" 10 | footer = "true" 11 | -------------------------------------------------------------------------------- /sphinx/themes/pyramid/static/dialog-note.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/pyramid/static/dialog-note.png -------------------------------------------------------------------------------- /sphinx/themes/pyramid/static/dialog-seealso.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/pyramid/static/dialog-seealso.png -------------------------------------------------------------------------------- /sphinx/themes/pyramid/static/dialog-todo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/pyramid/static/dialog-todo.png -------------------------------------------------------------------------------- /sphinx/themes/pyramid/static/dialog-topic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/pyramid/static/dialog-topic.png -------------------------------------------------------------------------------- /sphinx/themes/pyramid/static/dialog-warning.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/pyramid/static/dialog-warning.png -------------------------------------------------------------------------------- /sphinx/themes/pyramid/static/footerbg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/pyramid/static/footerbg.png -------------------------------------------------------------------------------- /sphinx/themes/pyramid/static/headerbg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/pyramid/static/headerbg.png -------------------------------------------------------------------------------- /sphinx/themes/pyramid/static/middlebg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/pyramid/static/middlebg.png -------------------------------------------------------------------------------- /sphinx/themes/pyramid/static/transparent.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/pyramid/static/transparent.gif -------------------------------------------------------------------------------- /sphinx/themes/pyramid/theme.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = "basic" 3 | stylesheets = [ 4 | "pyramid.css", 5 | ] 6 | pygments_style = { default = "sphinx.pygments_styles.PyramidStyle" } 7 | -------------------------------------------------------------------------------- /sphinx/themes/scrolls/static/darkmetal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/scrolls/static/darkmetal.png -------------------------------------------------------------------------------- /sphinx/themes/scrolls/static/headerbg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/scrolls/static/headerbg.png -------------------------------------------------------------------------------- /sphinx/themes/scrolls/static/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/scrolls/static/logo.png -------------------------------------------------------------------------------- /sphinx/themes/scrolls/static/metal.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/scrolls/static/metal.png -------------------------------------------------------------------------------- /sphinx/themes/scrolls/static/navigation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/scrolls/static/navigation.png -------------------------------------------------------------------------------- /sphinx/themes/scrolls/static/watermark.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/scrolls/static/watermark.png -------------------------------------------------------------------------------- /sphinx/themes/scrolls/static/watermark_blur.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/scrolls/static/watermark_blur.png -------------------------------------------------------------------------------- /sphinx/themes/sphinxdoc/static/contents.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/sphinxdoc/static/contents.png -------------------------------------------------------------------------------- /sphinx/themes/sphinxdoc/static/navigation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/sphinx/themes/sphinxdoc/static/navigation.png -------------------------------------------------------------------------------- /sphinx/themes/sphinxdoc/theme.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = "basic" 3 | stylesheets = [ 4 | "sphinxdoc.css", 5 | ] 6 | pygments_style = { default = "friendly" } 7 | -------------------------------------------------------------------------------- /sphinx/themes/traditional/theme.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = "basic" 3 | stylesheets = [ 4 | "traditional.css", 5 | ] 6 | 7 | [options] 8 | body_min_width = "0" 9 | body_max_width = "none" 10 | -------------------------------------------------------------------------------- /sphinx/writers/__init__.py: -------------------------------------------------------------------------------- 1 | """Custom docutils writers.""" 2 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/__init__.py -------------------------------------------------------------------------------- /tests/js/documentation_options.js: -------------------------------------------------------------------------------- 1 | const DOCUMENTATION_OPTIONS = {}; 2 | -------------------------------------------------------------------------------- /tests/js/roots/cpp/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/js/roots/cpp/conf.py -------------------------------------------------------------------------------- /tests/js/roots/multiterm/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/js/roots/multiterm/conf.py -------------------------------------------------------------------------------- /tests/js/roots/partial/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/js/roots/partial/conf.py -------------------------------------------------------------------------------- /tests/js/roots/titles/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autodoc'] 7 | -------------------------------------------------------------------------------- /tests/js/roots/titles/relevance.py: -------------------------------------------------------------------------------- 1 | class Example: 2 | """Example class""" 3 | 4 | num_attribute = 5 5 | text_attribute = 'string' 6 | 7 | relevance = 'testing' 8 | """attribute docstring""" 9 | -------------------------------------------------------------------------------- /tests/roots/test-_blank/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-_blank/conf.py -------------------------------------------------------------------------------- /tests/roots/test-_blank/index.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-_blank/index.rst -------------------------------------------------------------------------------- /tests/roots/test-add_enumerable_node/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['enumerable_node'] 7 | 8 | numfig = True 9 | -------------------------------------------------------------------------------- /tests/roots/test-add_enumerable_node/rimg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-add_enumerable_node/rimg.png -------------------------------------------------------------------------------- /tests/roots/test-add_source_parser/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['source_parser'] 7 | -------------------------------------------------------------------------------- /tests/roots/test-api-set-translator/index.rst: -------------------------------------------------------------------------------- 1 | ======================= 2 | Test API set_translator 3 | ======================= 4 | -------------------------------------------------------------------------------- /tests/roots/test-api-set-translator/nonext/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | project = 'test' 7 | -------------------------------------------------------------------------------- /tests/roots/test-api-set-translator/translator.py: -------------------------------------------------------------------------------- 1 | from sphinx.writers.html import HTML5Translator 2 | 3 | 4 | class ExtHTMLTranslator(HTML5Translator): 5 | pass 6 | -------------------------------------------------------------------------------- /tests/roots/test-basic/conf.py: -------------------------------------------------------------------------------- 1 | html_theme = 'basic' 2 | latex_documents = [ 3 | ( 4 | 'index', 5 | 'test.tex', 6 | 'The basic Sphinx documentation for testing', 7 | 'Sphinx', 8 | 'report', 9 | ) 10 | ] 11 | -------------------------------------------------------------------------------- /tests/roots/test-build-html-theme-having-multiple-stylesheets/_themes/mytheme/_static/extra.css: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-build-html-theme-having-multiple-stylesheets/_themes/mytheme/_static/extra.css -------------------------------------------------------------------------------- /tests/roots/test-build-html-theme-having-multiple-stylesheets/_themes/mytheme/theme.conf: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = basic 3 | stylesheet = mytheme.css, extra.css 4 | -------------------------------------------------------------------------------- /tests/roots/test-build-html-theme-having-multiple-stylesheets/conf.py: -------------------------------------------------------------------------------- 1 | html_theme_path = ['_themes'] 2 | html_theme = 'mytheme' 3 | -------------------------------------------------------------------------------- /tests/roots/test-build-html-theme-having-multiple-stylesheets/index.rst: -------------------------------------------------------------------------------- 1 | test-build-html-theme-having-multiple-stylesheets 2 | ================================================= 3 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/conf.py: -------------------------------------------------------------------------------- 1 | source_suffix = { 2 | '.txt': 'restructuredtext', 3 | } 4 | exclude_patterns = ['_build'] 5 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/doc1.txt: -------------------------------------------------------------------------------- 1 | Section A 2 | ========= 3 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/doc2.txt: -------------------------------------------------------------------------------- 1 | Section B 2 | ========= 3 | 4 | Sub Ba 5 | ------ 6 | 7 | Sub Bb 8 | ------ 9 | 10 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/index.txt: -------------------------------------------------------------------------------- 1 | .. toctree:: 2 | :numbered: 3 | 4 | doc1 5 | doc2 6 | maxwidth 7 | lineblock 8 | nonascii_title 9 | nonascii_table 10 | nonascii_maxwidth 11 | table 12 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/lineblock.txt: -------------------------------------------------------------------------------- 1 | * one 2 | 3 | | line-block 1 4 | | line-block 2 5 | 6 | followed paragraph. 7 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/listitems.txt: -------------------------------------------------------------------------------- 1 | .. seealso:: 2 | 3 | * item 1 4 | * item 2 5 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/nonascii_table.txt: -------------------------------------------------------------------------------- 1 | .. list-table:: 2 | 3 | - - spam 4 | - egg 5 | 6 | - - 日本語 7 | - 日本語 8 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/nonascii_title.txt: -------------------------------------------------------------------------------- 1 | 日本語 2 | ====== 3 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/table.txt: -------------------------------------------------------------------------------- 1 | +-----+-----+ 2 | | XXX | XXX | 3 | +-----+-----+ 4 | | | XXX | 5 | +-----+-----+ 6 | | XXX | | 7 | +-----+-----+ 8 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/table_colspan.txt: -------------------------------------------------------------------------------- 1 | +-----+-----+ 2 | | XXX | XXX | 3 | +-----+-----+ 4 | | | XXX | 5 | +-----+ | 6 | | XXX | | 7 | +-----+-----+ 8 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/table_colspan_and_rowspan.txt: -------------------------------------------------------------------------------- 1 | +-----------+-----+ 2 | | AAA | BBB | 3 | +-----+-----+ | 4 | | | XXX | | 5 | | +-----+-----+ 6 | | DDD | CCC | 7 | +-----+-----------+ 8 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/table_colspan_left.txt: -------------------------------------------------------------------------------- 1 | +-----+-----+ 2 | | XXX | XXX | 3 | +-----+-----+ 4 | | | XXX | 5 | | +-----+ 6 | | XXX | | 7 | +-----+-----+ 8 | -------------------------------------------------------------------------------- /tests/roots/test-build-text/table_rowspan.txt: -------------------------------------------------------------------------------- 1 | +-----+-----+ 2 | | XXXXXXXXX | 3 | +-----+-----+ 4 | | | XXX | 5 | +-----+-----+ 6 | | XXX | | 7 | +-----+-----+ 8 | -------------------------------------------------------------------------------- /tests/roots/test-builder-dirhtml/bar.rst: -------------------------------------------------------------------------------- 1 | .. _bar: 2 | 3 | bar 4 | === 5 | -------------------------------------------------------------------------------- /tests/roots/test-builder-dirhtml/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-builder-dirhtml/conf.py -------------------------------------------------------------------------------- /tests/roots/test-builder-dirhtml/foo/foo_1.rst: -------------------------------------------------------------------------------- 1 | .. _foo_1: 2 | 3 | foo/foo_1 4 | ========= 5 | -------------------------------------------------------------------------------- /tests/roots/test-builder-dirhtml/foo/foo_2.rst: -------------------------------------------------------------------------------- 1 | .. _foo_2: 2 | 3 | foo/foo_2 4 | ========= 5 | -------------------------------------------------------------------------------- /tests/roots/test-builder-dirhtml/foo/index.rst: -------------------------------------------------------------------------------- 1 | .. _foo: 2 | 3 | foo/index 4 | ========= 5 | 6 | .. toctree:: 7 | 8 | foo_1 9 | foo_2 10 | -------------------------------------------------------------------------------- /tests/roots/test-builder-dirhtml/index.rst: -------------------------------------------------------------------------------- 1 | .. _index: 2 | 3 | index 4 | ===== 5 | 6 | .. toctree:: 7 | 8 | foo/index 9 | bar 10 | -------------------------------------------------------------------------------- /tests/roots/test-builder-gettext-dont-rebuild-mo/bom.rst: -------------------------------------------------------------------------------- 1 | File with UTF-8 BOM 2 | =================== 3 | 4 | This file has a UTF-8 "BOM". 5 | 6 | -------------------------------------------------------------------------------- /tests/roots/test-builder-gettext-dont-rebuild-mo/conf.py: -------------------------------------------------------------------------------- 1 | language = 'xx' 2 | -------------------------------------------------------------------------------- /tests/roots/test-builder-gettext-dont-rebuild-mo/index.rst: -------------------------------------------------------------------------------- 1 | The basic Sphinx documentation for testing 2 | ========================================== 3 | 4 | .. toctree:: 5 | 6 | bom 7 | -------------------------------------------------------------------------------- /tests/roots/test-changes/conf.py: -------------------------------------------------------------------------------- 1 | project = 'Sphinx ChangesBuilder tests' 2 | copyright = '2007' 3 | version = '0.6' 4 | release = '0.6alpha1' 5 | -------------------------------------------------------------------------------- /tests/roots/test-circular/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-circular/index.rst: -------------------------------------------------------------------------------- 1 | .. toctree:: 2 | 3 | sub 4 | 5 | -------------------------------------------------------------------------------- /tests/roots/test-circular/sub.rst: -------------------------------------------------------------------------------- 1 | .. toctree:: 2 | 3 | index 4 | -------------------------------------------------------------------------------- /tests/roots/test-config/conf.py: -------------------------------------------------------------------------------- 1 | project = 'Sphinx ' 2 | release = '0.6alpha1' 3 | templates_path = ['_templates'] 4 | -------------------------------------------------------------------------------- /tests/roots/test-copyright-multiline/conf.py: -------------------------------------------------------------------------------- 1 | copyright = ( 2 | '2006', 3 | '2006-2009, Alice', 4 | '2010-2013, Bob', 5 | '2014-2017, Charlie', 6 | '2018-2021, David', 7 | '2022-2025, Eve', 8 | ) 9 | html_theme = 'basic' 10 | -------------------------------------------------------------------------------- /tests/roots/test-copyright-multiline/index.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-copyright-multiline/index.rst -------------------------------------------------------------------------------- /tests/roots/test-default_role/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-default_role/conf.py -------------------------------------------------------------------------------- /tests/roots/test-default_role/foo.rst: -------------------------------------------------------------------------------- 1 | foo.rst 2 | ======= 3 | 4 | `OK` button 5 | -------------------------------------------------------------------------------- /tests/roots/test-default_role/index.rst: -------------------------------------------------------------------------------- 1 | default_role 2 | ============ 3 | 4 | .. default-role:: pep 5 | 6 | `8` 7 | -------------------------------------------------------------------------------- /tests/roots/test-directive-code/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | numfig = True 3 | -------------------------------------------------------------------------------- /tests/roots/test-directive-code/emphasize.rst: -------------------------------------------------------------------------------- 1 | Literal Includes with Highlighted Lines 2 | ======================================= 3 | 4 | .. literalinclude:: target.py 5 | :language: python 6 | :emphasize-lines: 6-7, 16-19, 29- 7 | -------------------------------------------------------------------------------- /tests/roots/test-directive-code/empty.inc: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /tests/roots/test-directive-code/error.inc: -------------------------------------------------------------------------------- 1 | not a python script! 2 | -------------------------------------------------------------------------------- /tests/roots/test-directive-code/literal-short.inc: -------------------------------------------------------------------------------- 1 | # Very small literal include (linenothreshold check) 2 | 3 | value = True 4 | -------------------------------------------------------------------------------- /tests/roots/test-directive-csv-table/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-directive-csv-table/conf.py -------------------------------------------------------------------------------- /tests/roots/test-directive-csv-table/example.csv: -------------------------------------------------------------------------------- 1 | foo,bar,baz 2 | -------------------------------------------------------------------------------- /tests/roots/test-directive-csv-table/subdir/example.csv: -------------------------------------------------------------------------------- 1 | FOO,BAR,BAZ 2 | -------------------------------------------------------------------------------- /tests/roots/test-directive-include/bar.txt: -------------------------------------------------------------------------------- 1 | Text from :file:`bar.txt`. 2 | -------------------------------------------------------------------------------- /tests/roots/test-directive-include/baz/baz.rst: -------------------------------------------------------------------------------- 1 | Baz 2 | === 3 | 4 | .. include:: foo.rst 5 | 6 | Baz was here. 7 | -------------------------------------------------------------------------------- /tests/roots/test-directive-include/conf.py: -------------------------------------------------------------------------------- 1 | project = 'test-directive-include' 2 | exclude_patterns = ['_build'] 3 | -------------------------------------------------------------------------------- /tests/roots/test-directive-include/foo.rst: -------------------------------------------------------------------------------- 1 | The #magical foo. 2 | -------------------------------------------------------------------------------- /tests/roots/test-directive-include/text.txt: -------------------------------------------------------------------------------- 1 | This is plain text. 2 | -------------------------------------------------------------------------------- /tests/roots/test-directive-only/conf.py: -------------------------------------------------------------------------------- 1 | project = 'test-directive-only' 2 | exclude_patterns = ['_build'] 3 | -------------------------------------------------------------------------------- /tests/roots/test-directive-only/index.rst: -------------------------------------------------------------------------------- 1 | test-directive-only 2 | =================== 3 | 4 | .. toctree:: 5 | 6 | only 7 | -------------------------------------------------------------------------------- /tests/roots/test-directives-admonition-collapse/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-directives-admonition-collapse/conf.py -------------------------------------------------------------------------------- /tests/roots/test-directives-raw/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-directives-raw/conf.py -------------------------------------------------------------------------------- /tests/roots/test-docutilsconf/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-docutilsconf/conf.py -------------------------------------------------------------------------------- /tests/roots/test-docutilsconf/docutils.conf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-docutilsconf/docutils.conf -------------------------------------------------------------------------------- /tests/roots/test-docutilsconf/index.rst: -------------------------------------------------------------------------------- 1 | test-docutilsconf 2 | ================== 3 | 4 | Sphinx [1]_ 5 | 6 | .. [1] Python Documentation Generator 7 | -------------------------------------------------------------------------------- /tests/roots/test-domain-c-c_maximum_signature_line_length/conf.py: -------------------------------------------------------------------------------- 1 | c_maximum_signature_line_length = len('str hello(str name)') - 1 2 | -------------------------------------------------------------------------------- /tests/roots/test-domain-c-c_maximum_signature_line_length/index.rst: -------------------------------------------------------------------------------- 1 | domain-c-c_maximum_signature_line_length 2 | ======================================== 3 | 4 | .. c:function:: str hello(str name) 5 | -------------------------------------------------------------------------------- /tests/roots/test-domain-c-intersphinx/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | extensions = [ 3 | 'sphinx.ext.intersphinx', 4 | ] 5 | -------------------------------------------------------------------------------- /tests/roots/test-domain-c/anon-dup-decl.rst: -------------------------------------------------------------------------------- 1 | .. c:namespace:: anon_dup_decl_ns 2 | 3 | .. c:struct:: anon_dup_decl 4 | 5 | .. c:struct:: @a.A 6 | .. c:struct:: @b.A 7 | .. c:struct:: A 8 | -------------------------------------------------------------------------------- /tests/roots/test-domain-c/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-domain-c/field-role.rst: -------------------------------------------------------------------------------- 1 | .. c:function:: void f(int a, int *b) 2 | 3 | :param int a: 4 | :param int* b: 5 | -------------------------------------------------------------------------------- /tests/roots/test-domain-c/function_param_target.rst: -------------------------------------------------------------------------------- 1 | .. c:namespace:: function_param_target 2 | 3 | .. c:function:: void f(int i) 4 | 5 | - :c:var:`i` 6 | 7 | - :c:var:`f.i` 8 | -------------------------------------------------------------------------------- /tests/roots/test-domain-c/ns_lookup.rst: -------------------------------------------------------------------------------- 1 | .. c:namespace:: ns_lookup 2 | 3 | .. c:var:: int i 4 | 5 | .. c:function:: void f(int j) 6 | 7 | - :c:var:`i` 8 | - :c:var:`j` 9 | - :c:expr:`i` 10 | - :c:expr:`j` 11 | 12 | - :c:var:`i` 13 | - :c:expr:`i` 14 | -------------------------------------------------------------------------------- /tests/roots/test-domain-cpp-cpp_maximum_signature_line_length/conf.py: -------------------------------------------------------------------------------- 1 | cpp_maximum_signature_line_length = len('str hello(str name)') - 1 2 | -------------------------------------------------------------------------------- /tests/roots/test-domain-cpp-cpp_maximum_signature_line_length/index.rst: -------------------------------------------------------------------------------- 1 | domain-cpp-cpp_maximum_signature_line_length 2 | ============================================ 3 | 4 | .. cpp:function:: str hello(str name) 5 | -------------------------------------------------------------------------------- /tests/roots/test-domain-cpp-intersphinx/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | extensions = [ 3 | 'sphinx.ext.intersphinx', 4 | ] 5 | -------------------------------------------------------------------------------- /tests/roots/test-domain-cpp/anon-dup-decl.rst: -------------------------------------------------------------------------------- 1 | .. cpp:namespace:: anon_dup_decl 2 | .. cpp:class:: @a::A 3 | .. cpp:class:: @b::A 4 | .. cpp:class:: A 5 | -------------------------------------------------------------------------------- /tests/roots/test-domain-cpp/backslash.rst: -------------------------------------------------------------------------------- 1 | .. cpp:var:: char c = '\\' 2 | -------------------------------------------------------------------------------- /tests/roots/test-domain-cpp/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-domain-cpp/field-role.rst: -------------------------------------------------------------------------------- 1 | .. cpp:function:: void f() 2 | 3 | :throws int: 4 | :throws int*: 5 | 6 | -------------------------------------------------------------------------------- /tests/roots/test-domain-cpp/lookup-key-overload.rst: -------------------------------------------------------------------------------- 1 | .. default-domain:: cpp 2 | 3 | .. namespace:: lookup_key_overload 4 | 5 | .. function:: void g(int a) 6 | .. function:: void g(double b) 7 | 8 | :var:`b` 9 | -------------------------------------------------------------------------------- /tests/roots/test-domain-cpp/roles2.rst: -------------------------------------------------------------------------------- 1 | Check that we don't crash just because we misuse a role. 2 | 3 | .. cpp:class:: A 4 | 5 | :cpp:func:`A` 6 | -------------------------------------------------------------------------------- /tests/roots/test-domain-js-javascript_maximum_signature_line_length/conf.py: -------------------------------------------------------------------------------- 1 | javascript_maximum_signature_line_length = 1 2 | -------------------------------------------------------------------------------- /tests/roots/test-domain-js-javascript_maximum_signature_line_length/index.rst: -------------------------------------------------------------------------------- 1 | domain-js-maximum_signature_line_length 2 | ======================================= 3 | 4 | .. js:function:: hello(name) 5 | 6 | .. js:function:: foo([a, [b, ]]c, d[, e, f]) 7 | -------------------------------------------------------------------------------- /tests/roots/test-domain-js/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-domain-js/index.rst: -------------------------------------------------------------------------------- 1 | test-domain-js 2 | ============== 3 | 4 | .. toctree:: 5 | 6 | roles 7 | module 8 | -------------------------------------------------------------------------------- /tests/roots/test-domain-py-python_maximum_signature_line_length/conf.py: -------------------------------------------------------------------------------- 1 | python_maximum_signature_line_length = 1 2 | -------------------------------------------------------------------------------- /tests/roots/test-domain-py-python_use_unqualified_type_names/conf.py: -------------------------------------------------------------------------------- 1 | python_use_unqualified_type_names = True 2 | -------------------------------------------------------------------------------- /tests/roots/test-domain-py-xref-warning/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-domain-py-xref-warning/conf.py -------------------------------------------------------------------------------- /tests/roots/test-domain-py-xref-warning/index.rst: -------------------------------------------------------------------------------- 1 | test-domain-py-xref-warning 2 | =========================== 3 | 4 | .. _existing-label: 5 | 6 | :ref:`no-label` 7 | :ref:`existing-label` 8 | -------------------------------------------------------------------------------- /tests/roots/test-domain-py/canonical.rst: -------------------------------------------------------------------------------- 1 | caninical 2 | ========= 3 | 4 | :py:class:`.Foo` 5 | :any:`Foo` 6 | :any:`module.Foo` 7 | :any:`original.module.Foo` 8 | 9 | .. py:module:: canonical 10 | 11 | .. py:class:: Foo 12 | :canonical: original.module.Foo 13 | -------------------------------------------------------------------------------- /tests/roots/test-domain-py/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-domain-py/index.rst: -------------------------------------------------------------------------------- 1 | test-domain-py 2 | ============== 3 | 4 | .. toctree:: 5 | 6 | roles 7 | module 8 | module_option 9 | abbr 10 | canonical 11 | type_alias 12 | -------------------------------------------------------------------------------- /tests/roots/test-double-inheriting-theme/base_themes_dir/base_theme1/theme.conf: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = basic 3 | -------------------------------------------------------------------------------- /tests/roots/test-double-inheriting-theme/base_themes_dir/base_theme2/theme.conf: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = base_theme1 3 | -------------------------------------------------------------------------------- /tests/roots/test-double-inheriting-theme/conf.py: -------------------------------------------------------------------------------- 1 | templates_path = ['_templates'] 2 | html_theme = 'base_theme2' 3 | html_theme_path = ['base_themes_dir'] 4 | exclude_patterns = ['_build'] 5 | -------------------------------------------------------------------------------- /tests/roots/test-double-inheriting-theme/index.rst: -------------------------------------------------------------------------------- 1 | ============================ 2 | Test double inheriting theme 3 | ============================ 4 | -------------------------------------------------------------------------------- /tests/roots/test-environment-record-dependencies/api.rst: -------------------------------------------------------------------------------- 1 | API 2 | === 3 | 4 | .. automodule:: example_module 5 | -------------------------------------------------------------------------------- /tests/roots/test-environment-record-dependencies/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autodoc'] 7 | -------------------------------------------------------------------------------- /tests/roots/test-environment-record-dependencies/example_module.py: -------------------------------------------------------------------------------- 1 | def example_function(): 2 | return 42 3 | -------------------------------------------------------------------------------- /tests/roots/test-environment-record-dependencies/index.rst: -------------------------------------------------------------------------------- 1 | .. toctree:: 2 | 3 | api 4 | -------------------------------------------------------------------------------- /tests/roots/test-epub-anchor-id/conf.py: -------------------------------------------------------------------------------- 1 | def setup(app): 2 | app.add_crossref_type(directivename='setting', rolename='setting') 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-custom-templates/_templates/module.rst.jinja: -------------------------------------------------------------------------------- 1 | The Jinja module template was found! 2 | ------------------------------------ 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-custom-templates/_templates/module.rst_t: -------------------------------------------------------------------------------- 1 | The legacy module template was found! 2 | ------------------------------------- 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-custom-templates/_templates/package.rst_t: -------------------------------------------------------------------------------- 1 | The legacy package template was found! 2 | -------------------------------------- 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-custom-templates/mypackage/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-custom-templates/mypackage/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-custom-templates/mypackage/mymodule.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-custom-templates/mypackage/mymodule.py -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-duplicates/fish_licence/halibut.cpython-38-x86_64-linux-gnu.so: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-duplicates/fish_licence/halibut.cpython-38-x86_64-linux-gnu.so -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-duplicates/fish_licence/halibut.pyd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-duplicates/fish_licence/halibut.pyd -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-duplicates/fish_licence/halibut.pyi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-duplicates/fish_licence/halibut.pyi -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-duplicates/fish_licence/halibut.pyx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-duplicates/fish_licence/halibut.pyx -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-pep420/a/b/c/__init__.py: -------------------------------------------------------------------------------- 1 | """Package C""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-pep420/a/b/c/d.py: -------------------------------------------------------------------------------- 1 | """Module d""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-pep420/a/b/e/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-pep420/a/b/e/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-pep420/a/b/e/f.py: -------------------------------------------------------------------------------- 1 | """Module f""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-pep420/a/b/x/y.py: -------------------------------------------------------------------------------- 1 | """Module y""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-subpackage-in-toc/parent/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-subpackage-in-toc/parent/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-subpackage-in-toc/parent/child/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-subpackage-in-toc/parent/child/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-subpackage-in-toc/parent/child/foo.py: -------------------------------------------------------------------------------- 1 | """foo""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-toc/mypackage/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-toc/mypackage/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-toc/mypackage/no_init/foo.py: -------------------------------------------------------------------------------- 1 | MESSAGE = "There's no __init__.py in this folder, hence we should be left out" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-toc/mypackage/resource/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-apidoc-toc/mypackage/resource/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-toc/mypackage/resource/resource.txt: -------------------------------------------------------------------------------- 1 | This is a text resource to be included in this otherwise empty module. No python contents here. 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-toc/mypackage/something/__init__.py: -------------------------------------------------------------------------------- 1 | """Subpackage Something""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc-trailing-underscore/package_/__init__.py: -------------------------------------------------------------------------------- 1 | """A package with trailing underscores""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc/index.rst: -------------------------------------------------------------------------------- 1 | Heading 2 | ======= 3 | 4 | .. toctree:: 5 | 6 | generated/modules 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc/src/exclude_package.py: -------------------------------------------------------------------------------- 1 | """A module that should be excluded.""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-apidoc/src/my_package.py: -------------------------------------------------------------------------------- 1 | """An example module.""" 2 | 3 | 4 | def example_function(a: str) -> str: 5 | """An example function.""" 6 | return a 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/autodoc_dummy_bar.py: -------------------------------------------------------------------------------- 1 | from bug2437.autodoc_dummy_foo import Foo 2 | 3 | 4 | class Bar: 5 | """Dummy class Bar with alias.""" 6 | 7 | my_name = Foo 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/autodoc_dummy_module.py: -------------------------------------------------------------------------------- 1 | from dummy import * # NoQA: F403 2 | 3 | 4 | def test(): 5 | """Dummy function using dummy.*""" 6 | dummy_function() # NoQA: F405 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/bug2437/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-autodoc/bug2437/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/bug2437/autodoc_dummy_foo.py: -------------------------------------------------------------------------------- 1 | class Foo: 2 | """Dummy class Foo.""" 3 | 4 | pass 5 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/circular_import/__init__.py: -------------------------------------------------------------------------------- 1 | from circular_import.c import SomeClass 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/circular_import/a.py: -------------------------------------------------------------------------------- 1 | X = 42 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/circular_import/b.py: -------------------------------------------------------------------------------- 1 | import typing 2 | 3 | if typing.TYPE_CHECKING: 4 | from circular_import import SomeClass 5 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/circular_import/c.py: -------------------------------------------------------------------------------- 1 | import circular_import.a 2 | import circular_import.b 3 | 4 | 5 | class SomeClass: 6 | X = circular_import.a.X 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autodoc'] 7 | 8 | autodoc_mock_imports = [ 9 | 'dummy', 10 | ] 11 | 12 | nitpicky = True 13 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/_functions_to_import.py: -------------------------------------------------------------------------------- 1 | from typing import TYPE_CHECKING, Optional 2 | 3 | if TYPE_CHECKING: 4 | from sphinx.application import Sphinx 5 | 6 | 7 | def function_to_be_imported(app: Optional['Sphinx']) -> str: 8 | """docstring""" 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/bound_method.py: -------------------------------------------------------------------------------- 1 | class Cls: 2 | def method(self): 3 | """Method docstring""" 4 | pass 5 | 6 | 7 | bound_method = Cls().method 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/canonical/__init__.py: -------------------------------------------------------------------------------- 1 | from target.canonical.original import Bar, Foo 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/empty_all.py: -------------------------------------------------------------------------------- 1 | """docsting of empty_all module.""" 2 | 3 | __all__ = [] 4 | 5 | 6 | def foo(): 7 | """docstring""" 8 | 9 | 10 | def bar(): 11 | """docstring""" 12 | 13 | 14 | def baz(): 15 | """docstring""" 16 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/imported_members.py: -------------------------------------------------------------------------------- 1 | from .partialfunction import func2, func3 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/metadata.py: -------------------------------------------------------------------------------- 1 | def foo(): 2 | """:meta metadata-only-docstring:""" 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/module.py: -------------------------------------------------------------------------------- 1 | undocumented = 1 2 | 3 | #: docstring 4 | documented = 1 5 | 6 | undoc_annotated: int 7 | 8 | #: docstring 9 | annotated: int 10 | 11 | __special__ = 1 12 | 13 | #: docstring 14 | __documented_special__ = 1 15 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/name_conflict/__init__.py: -------------------------------------------------------------------------------- 1 | from .foo import bar 2 | 3 | 4 | class foo: 5 | """docstring of target.name_conflict::foo.""" 6 | 7 | pass 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/name_conflict/foo.py: -------------------------------------------------------------------------------- 1 | class bar: 2 | """docstring of target.name_conflict.foo::bar.""" 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/name_mangling.py: -------------------------------------------------------------------------------- 1 | class Foo: 2 | #: name of Foo 3 | __name = None 4 | __age = None 5 | 6 | 7 | class Bar(Foo): 8 | __address = None 9 | 10 | #: a member having mangled-like name 11 | _Baz__email = None 12 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/overload2.py: -------------------------------------------------------------------------------- 1 | from target.overload import Bar 2 | 3 | 4 | class Baz(Bar): 5 | pass 6 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/pep570.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-autodoc/target/pep570.py -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/process_docstring.py: -------------------------------------------------------------------------------- 1 | def func(): 2 | """first line 3 | --- 4 | second line 5 | --- 6 | third line 7 | """ 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autodoc/target/uninitialized_attributes.py: -------------------------------------------------------------------------------- 1 | class Base: 2 | attr1: int #: docstring 3 | attr2: str 4 | 5 | 6 | class Derived(Base): 7 | attr3: int #: docstring 8 | attr4: str 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosectionlabel-prefix-document/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.autosectionlabel'] 2 | autosectionlabel_prefix_document = True 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosectionlabel/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.autosectionlabel'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-ext/index.rst: -------------------------------------------------------------------------------- 1 | 2 | .. autosummary:: 3 | :signatures: none 4 | :toctree: 5 | 6 | dummy_module 7 | underscore_module_ 8 | sphinx 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-import_cycle/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autosummary'] 7 | autosummary_generate = False 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-import_cycle/index.rst: -------------------------------------------------------------------------------- 1 | .. automodule:: spam.eggs 2 | :members: 3 | 4 | .. autosummary:: 5 | 6 | spam.eggs.Ham 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-import_cycle/spam/__init__.py: -------------------------------------------------------------------------------- 1 | """``spam`` module docstring.""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-import_cycle/spam/eggs.py: -------------------------------------------------------------------------------- 1 | """``spam.eggs`` module docstring.""" 2 | 3 | import spam # Required for test. 4 | 5 | 6 | class Ham: 7 | """``spam.eggs.Ham`` class docstring.""" 8 | 9 | a = 1 10 | b = 2 11 | c = 3 12 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-imported_members/autosummary_dummy_package/__init__.py: -------------------------------------------------------------------------------- 1 | from .autosummary_dummy_module import Bar, foo 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-imported_members/autosummary_dummy_package/autosummary_dummy_module.py: -------------------------------------------------------------------------------- 1 | class Bar: 2 | """Bar class""" 3 | 4 | pass 5 | 6 | 7 | def foo(): 8 | """Foo function""" 9 | pass 10 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-imported_members/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autosummary'] 7 | autosummary_generate = True 8 | autosummary_imported_members = True 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-imported_members/index.rst: -------------------------------------------------------------------------------- 1 | test-ext-autosummary-imported_members 2 | ===================================== 3 | 4 | .. autosummary:: 5 | :toctree: generated 6 | 7 | autosummary_dummy_package 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-mock_imports/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autosummary'] 7 | autosummary_generate = True 8 | autosummary_mock_imports = ['unknown'] 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-mock_imports/foo.py: -------------------------------------------------------------------------------- 1 | import unknown 2 | 3 | 4 | class Foo(unknown.Class): 5 | """Foo class""" 6 | 7 | pass 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-mock_imports/index.rst: -------------------------------------------------------------------------------- 1 | test-ext-autosummary-mock_imports 2 | ================================= 3 | 4 | .. autosummary:: 5 | :toctree: generated 6 | 7 | foo 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-module_all/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autosummary'] 7 | autosummary_generate = True 8 | autosummary_ignore_module_all = False 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-module_all/index.rst: -------------------------------------------------------------------------------- 1 | test-ext-autosummary-module_all 2 | =============================== 3 | 4 | .. autosummary:: 5 | :toctree: generated 6 | :recursive: 7 | 8 | autosummary_dummy_package_all 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-module_empty_all/autosummary_dummy_package_empty_all/__init__.py: -------------------------------------------------------------------------------- 1 | __all__ = () 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-module_empty_all/index.rst: -------------------------------------------------------------------------------- 1 | test-ext-autosummary-module_all 2 | =============================== 3 | 4 | .. autosummary:: 5 | :toctree: generated 6 | :recursive: 7 | 8 | autosummary_dummy_package_empty_all 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-module_prefix/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = [ 7 | 'sphinx.ext.autosummary', 8 | ] 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-module_prefix/index.rst: -------------------------------------------------------------------------------- 1 | .. autosummary:: 2 | :toctree: docs/pkg 3 | :recursive: 4 | 5 | pkg 6 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-module_prefix/pkg/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-autosummary-module_prefix/pkg/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-module_prefix/pkg/mod0/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-autosummary-module_prefix/pkg/mod0/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-module_prefix/pkg/mod1/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-autosummary-module_prefix/pkg/mod1/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-recursive/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autosummary'] 7 | autosummary_generate = True 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-recursive/package/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-autosummary-recursive/package/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-recursive/package/module_importfail.py: -------------------------------------------------------------------------------- 1 | # Fail module import in a catastrophic way 2 | raise SystemExit(1) 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-recursive/package/package/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-autosummary-recursive/package/package/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-recursive/package2/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-autosummary-recursive/package2/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-skip-member/index.rst: -------------------------------------------------------------------------------- 1 | .. autosummary:: 2 | :toctree: generate 3 | 4 | target.Foo 5 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-template/_templates/empty.rst: -------------------------------------------------------------------------------- 1 | EMPTY 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-template/index.rst: -------------------------------------------------------------------------------- 1 | .. autosummary:: 2 | :toctree: generate 3 | :template: empty.rst 4 | 5 | target.Foo 6 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary-template/target.py: -------------------------------------------------------------------------------- 1 | class Foo: 2 | """docstring of Foo.""" 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary/autosummary_class_module.py: -------------------------------------------------------------------------------- 1 | class Class: 2 | pass 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary/autosummary_importfail.py: -------------------------------------------------------------------------------- 1 | # Fail module import in a catastrophic way 2 | raise SystemExit(1) 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-autosummary/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autosummary'] 7 | autosummary_generate = True 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-coverage/grog/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-coverage/grog/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-coverage/grog/coverage_missing.py: -------------------------------------------------------------------------------- 1 | """This module is intentionally not documented.""" 2 | 3 | 4 | class Missing: 5 | """An undocumented class.""" 6 | 7 | def missing_a(self): 8 | """An undocumented method.""" 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-coverage/index.rst: -------------------------------------------------------------------------------- 1 | .. automodule:: grog.coverage_ignored 2 | :members: 3 | 4 | 5 | .. automodule:: grog.coverage_not_ignored 6 | :members: 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-doctest-fail-fast/fail-fast.txt: -------------------------------------------------------------------------------- 1 | Testing fast failure in the doctest extension 2 | ============================================= 3 | 4 | >>> 1 + 1 5 | 2 6 | 7 | >>> 1 + 1 8 | 3 9 | 10 | >>> 1 + 1 11 | 3 12 | -------------------------------------------------------------------------------- /tests/roots/test-ext-doctest-with-autodoc/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | project = 'test project for doctest + autodoc reporting' 7 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-doctest-with-autodoc/dir/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-doctest-with-autodoc/dir/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-doctest-with-autodoc/dir/bar.py: -------------------------------------------------------------------------------- 1 | """>>> 'dir/bar.py:2'""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-doctest-with-autodoc/dir/inner.rst: -------------------------------------------------------------------------------- 1 | >>> 'dir/inner.rst:1' 2 | 3 | .. automodule:: dir.bar 4 | :members: 5 | -------------------------------------------------------------------------------- /tests/roots/test-ext-doctest-with-autodoc/foo.py: -------------------------------------------------------------------------------- 1 | """>>> 'foo.py:3'""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-doctest-with-autodoc/index.rst: -------------------------------------------------------------------------------- 1 | .. automodule:: foo 2 | :members: 3 | 4 | >>> 'index.rst:4' 5 | -------------------------------------------------------------------------------- /tests/roots/test-ext-doctest/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.doctest'] 2 | 3 | project = 'test project for doctest' 4 | root_doc = 'doctest' 5 | source_suffix = { 6 | '.txt': 'restructuredtext', 7 | } 8 | exclude_patterns = ['_build'] 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-extlinks-hardcoded-urls/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.extlinks'] 2 | extlinks = {'issue': ('https://github.com/sphinx-doc/sphinx/issues/%s', 'issue %s')} 3 | extlinks_detect_hardcoded_links = True 4 | -------------------------------------------------------------------------------- /tests/roots/test-ext-githubpages/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.githubpages'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-githubpages/index.rst: -------------------------------------------------------------------------------- 1 | githubpages 2 | =========== 3 | 4 | -------------------------------------------------------------------------------- /tests/roots/test-ext-graphviz/_static/images/test.svg: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-graphviz/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.graphviz'] 2 | exclude_patterns = ['_build'] 3 | html_static_path = ['_static'] 4 | -------------------------------------------------------------------------------- /tests/roots/test-ext-graphviz/graph.dot: -------------------------------------------------------------------------------- 1 | digraph { 2 | bar -> baz 3 | } 4 | -------------------------------------------------------------------------------- /tests/roots/test-ext-graphviz/graph.xx.dot: -------------------------------------------------------------------------------- 1 | digraph { 2 | BAR -> BAZ 3 | } 4 | -------------------------------------------------------------------------------- /tests/roots/test-ext-imgconverter/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.imgconverter'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-imgconverter/img.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-imgconverter/img.pdf -------------------------------------------------------------------------------- /tests/roots/test-ext-imgconverter/index.rst: -------------------------------------------------------------------------------- 1 | test-ext-imgconverter 2 | ===================== 3 | 4 | .. image:: svgimg.svg 5 | .. image:: img.pdf 6 | -------------------------------------------------------------------------------- /tests/roots/test-ext-imgmockconverter/1/svgimg.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /tests/roots/test-ext-imgmockconverter/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['mocksvgconverter'] 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-imgmockconverter/index.rst: -------------------------------------------------------------------------------- 1 | test-ext-imgconverter 2 | ===================== 3 | 4 | .. image:: ./1/svgimg.svg 5 | .. image:: ./2/svgimg.svg 6 | 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-inheritance_diagram/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.inheritance_diagram', 'sphinx.ext.intersphinx'] 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-inheritance_diagram/example/__init__.py: -------------------------------------------------------------------------------- 1 | # example.py 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-inheritance_diagram/example/sphinx.py: -------------------------------------------------------------------------------- 1 | # example.sphinx 2 | 3 | 4 | class DummyClass: 5 | pass 6 | -------------------------------------------------------------------------------- /tests/roots/test-ext-inheritance_diagram/external/other.py: -------------------------------------------------------------------------------- 1 | from test import Alice 2 | 3 | 4 | class Bob(Alice): 5 | pass 6 | -------------------------------------------------------------------------------- /tests/roots/test-ext-inheritance_diagram/subdir/page2.rst: -------------------------------------------------------------------------------- 1 | ================================================ 2 | test-ext-inheritance_diagram subdirectory page 2 3 | ================================================ 4 | 5 | .. py:class:: test.DocSubDir2 6 | -------------------------------------------------------------------------------- /tests/roots/test-ext-intersphinx-cppdomain/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.intersphinx'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-intersphinx-cppdomain/index.rst: -------------------------------------------------------------------------------- 1 | test-ext-intersphinx-cppdomain 2 | ============================== 3 | 4 | .. cpp:namespace:: foo 5 | 6 | :cpp:class:`Bar` 7 | 8 | .. cpp:function:: foons::bartype FooBarBaz() 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-intersphinx-role/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.intersphinx'] 2 | # the role should not honor this conf var 3 | intersphinx_disabled_reftypes = ['*'] 4 | -------------------------------------------------------------------------------- /tests/roots/test-ext-math-include/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-math-include/conf.py -------------------------------------------------------------------------------- /tests/roots/test-ext-math-include/included.rst: -------------------------------------------------------------------------------- 1 | Title 2 | ===== 3 | 4 | Some file including some maths. 5 | 6 | .. include:: math.rst -------------------------------------------------------------------------------- /tests/roots/test-ext-math-include/index.rst: -------------------------------------------------------------------------------- 1 | Test Math 2 | ========= 3 | 4 | .. toctree:: 5 | :numbered: 1 6 | 7 | included 8 | -------------------------------------------------------------------------------- /tests/roots/test-ext-math-include/math.rst: -------------------------------------------------------------------------------- 1 | :math:`1 + 1 = 2` 2 | ================= 3 | 4 | Lorem ipsum. -------------------------------------------------------------------------------- /tests/roots/test-ext-math-simple/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-math-simple/conf.py -------------------------------------------------------------------------------- /tests/roots/test-ext-math-simple/index.rst: -------------------------------------------------------------------------------- 1 | Test Math 2 | ========= 3 | 4 | .. math:: a^2+b^2=c^2 5 | -------------------------------------------------------------------------------- /tests/roots/test-ext-math/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-math/conf.py -------------------------------------------------------------------------------- /tests/roots/test-ext-math/nomath.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-math/nomath.rst -------------------------------------------------------------------------------- /tests/roots/test-ext-math/page.rst: -------------------------------------------------------------------------------- 1 | Test multiple pages 2 | =================== 3 | 4 | .. math:: 5 | :label: bar 6 | 7 | a = b + 1 8 | 9 | Referencing equations :eq:`foo` and :eq:`bar`. 10 | -------------------------------------------------------------------------------- /tests/roots/test-ext-napoleon-paramtype/index.rst: -------------------------------------------------------------------------------- 1 | test-ext-napoleon 2 | ================= 3 | 4 | .. automodule:: pkg.bar 5 | :members: 6 | 7 | .. automodule:: pkg.foo 8 | :members: 9 | -------------------------------------------------------------------------------- /tests/roots/test-ext-napoleon-paramtype/pkg/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-napoleon-paramtype/pkg/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-napoleon/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.napoleon'] 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-napoleon/index.rst: -------------------------------------------------------------------------------- 1 | test-ext-napoleon 2 | ================= 3 | 4 | .. toctree:: 5 | 6 | typehints 7 | -------------------------------------------------------------------------------- /tests/roots/test-ext-napoleon/mypackage/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-ext-napoleon/mypackage/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-ext-napoleon/typehints.rst: -------------------------------------------------------------------------------- 1 | typehints 2 | ========= 3 | 4 | .. automodule:: mypackage.typehints 5 | :members: 6 | -------------------------------------------------------------------------------- /tests/roots/test-ext-todo/bar.rst: -------------------------------------------------------------------------------- 1 | bar 2 | === 3 | 4 | .. todo:: todo in bar 5 | -------------------------------------------------------------------------------- /tests/roots/test-ext-todo/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.todo'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-todo/foo.rst: -------------------------------------------------------------------------------- 1 | foo 2 | === 3 | 4 | .. todo:: todo in foo 5 | 6 | .. py:function:: hello() 7 | 8 | :param bug: https://github.com/sphinx-doc/sphinx/pull/5800 9 | 10 | .. todo:: todo in param field 11 | -------------------------------------------------------------------------------- /tests/roots/test-ext-todo/index.rst: -------------------------------------------------------------------------------- 1 | test for sphinx.ext.todo 2 | ======================== 3 | 4 | .. toctree:: 5 | 6 | foo 7 | bar 8 | 9 | .. todolist:: 10 | 11 | .. todolist:: 12 | -------------------------------------------------------------------------------- /tests/roots/test-ext-viewcode-find-package/index.rst: -------------------------------------------------------------------------------- 1 | viewcode 2 | ======== 3 | 4 | .. currentmodule:: main_package.subpackage.submodule 5 | 6 | .. autofunction:: func1 7 | 8 | .. autoclass:: Class1 9 | 10 | .. autoclass:: Class3 11 | -------------------------------------------------------------------------------- /tests/roots/test-ext-viewcode-find-package/main_package/__init__.py: -------------------------------------------------------------------------------- 1 | from main_package import subpackage 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-viewcode-find-package/main_package/subpackage/__init__.py: -------------------------------------------------------------------------------- 1 | from main_package.subpackage._subpackage2 import submodule 2 | 3 | __all__ = ['submodule'] 4 | -------------------------------------------------------------------------------- /tests/roots/test-ext-viewcode-find-package/main_package/subpackage/_subpackage2/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-viewcode-find/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.viewcode'] 2 | exclude_patterns = ['_build'] 3 | viewcode_follow_imported_members = False 4 | -------------------------------------------------------------------------------- /tests/roots/test-ext-viewcode-find/not_a_package/__init__.py: -------------------------------------------------------------------------------- 1 | from .submodule import Class1, func1 2 | -------------------------------------------------------------------------------- /tests/roots/test-ext-viewcode/spam/__init__.py: -------------------------------------------------------------------------------- 1 | from .mod1 import Class1, func1 2 | from .mod2 import Class2, func2 3 | -------------------------------------------------------------------------------- /tests/roots/test-ext-viewcode/spam/mod3.py: -------------------------------------------------------------------------------- 1 | from spam.mod1 import Class3 2 | 3 | __all__ = ('Class3',) 4 | -------------------------------------------------------------------------------- /tests/roots/test-extensions/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | -------------------------------------------------------------------------------- /tests/roots/test-extensions/read_parallel.py: -------------------------------------------------------------------------------- 1 | def setup(app): 2 | return { 3 | 'parallel_read_safe': True, 4 | } 5 | -------------------------------------------------------------------------------- /tests/roots/test-extensions/read_serial.py: -------------------------------------------------------------------------------- 1 | def setup(app): 2 | return { 3 | 'parallel_read_safe': False, 4 | } 5 | -------------------------------------------------------------------------------- /tests/roots/test-extensions/write_parallel.py: -------------------------------------------------------------------------------- 1 | def setup(app): 2 | return { 3 | 'parallel_write_safe': True, 4 | } 5 | -------------------------------------------------------------------------------- /tests/roots/test-extensions/write_serial.py: -------------------------------------------------------------------------------- 1 | def setup(app): 2 | return { 3 | 'parallel_write_safe': False, 4 | } 5 | -------------------------------------------------------------------------------- /tests/roots/test-footnotes/bar.rst: -------------------------------------------------------------------------------- 1 | bar 2 | === 3 | 4 | Same footnote number [1]_ in bar.rst 5 | 6 | .. [1] footnote in bar 7 | -------------------------------------------------------------------------------- /tests/roots/test-footnotes/baz.rst: -------------------------------------------------------------------------------- 1 | baz 2 | === 3 | 4 | Auto footnote number [#]_ in baz.rst 5 | 6 | .. [#] footnote in baz 7 | -------------------------------------------------------------------------------- /tests/roots/test-footnotes/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-footnotes/rimg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-footnotes/rimg.png -------------------------------------------------------------------------------- /tests/roots/test-gettext-custom-output-template/conf.py: -------------------------------------------------------------------------------- 1 | templates_path = ['_templates'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-gettext-custom-output-template/index.rst: -------------------------------------------------------------------------------- 1 | CONTENTS 2 | ======== 3 | 4 | .. toctree:: 5 | :maxdepth: 2 6 | :numbered: 7 | :caption: Table of Contents 8 | -------------------------------------------------------------------------------- /tests/roots/test-gettext-template/_templates/template1.html: -------------------------------------------------------------------------------- 1 | {% extends "layout.html" %} 2 | {% block body %} 3 |

{{ _('Template 1') }}

4 |

{%trans%}This is Template 1.{%endtrans%}

5 | {% endblock %} 6 | -------------------------------------------------------------------------------- /tests/roots/test-gettext-template/_templates/template2.html: -------------------------------------------------------------------------------- 1 | {% extends "layout.html" %} 2 | {% block body %} 3 |

{{ _('Template 2') }}

4 |

{%trans%}This is Template 2.{%endtrans%}

5 | {% endblock %} 6 | -------------------------------------------------------------------------------- /tests/roots/test-gettext-template/conf.py: -------------------------------------------------------------------------------- 1 | templates_path = ['_templates'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-gettext-template/index.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-gettext-template/index.rst -------------------------------------------------------------------------------- /tests/roots/test-glossary/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-glossary/conf.py -------------------------------------------------------------------------------- /tests/roots/test-highlight_options/conf.py: -------------------------------------------------------------------------------- 1 | highlight_options = { 2 | 'default': {'default_option': True}, 3 | 'python': {'python_option': True}, 4 | } 5 | -------------------------------------------------------------------------------- /tests/roots/test-html_assets/extra/.htaccess: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/extra/.htaccess -------------------------------------------------------------------------------- /tests/roots/test-html_assets/extra/.htpasswd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/extra/.htpasswd -------------------------------------------------------------------------------- /tests/roots/test-html_assets/extra/API.html.jinja: -------------------------------------------------------------------------------- 1 | {{ project }}-{{ version }} 2 | -------------------------------------------------------------------------------- /tests/roots/test-html_assets/extra/css/style.css: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/extra/css/style.css -------------------------------------------------------------------------------- /tests/roots/test-html_assets/extra/index.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/extra/index.rst -------------------------------------------------------------------------------- /tests/roots/test-html_assets/extra/rimg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/extra/rimg.png -------------------------------------------------------------------------------- /tests/roots/test-html_assets/extra/subdir/.htaccess: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/extra/subdir/.htaccess -------------------------------------------------------------------------------- /tests/roots/test-html_assets/extra/subdir/.htpasswd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/extra/subdir/.htpasswd -------------------------------------------------------------------------------- /tests/roots/test-html_assets/index.rst: -------------------------------------------------------------------------------- 1 | test-html_extra_path 2 | ===================== 3 | this is dummy content 4 | -------------------------------------------------------------------------------- /tests/roots/test-html_assets/static/.htaccess: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/static/.htaccess -------------------------------------------------------------------------------- /tests/roots/test-html_assets/static/.htpasswd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/static/.htpasswd -------------------------------------------------------------------------------- /tests/roots/test-html_assets/static/API.html.jinja: -------------------------------------------------------------------------------- 1 | {{ project }}-{{ version }} 2 | -------------------------------------------------------------------------------- /tests/roots/test-html_assets/static/css/style.css: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/static/css/style.css -------------------------------------------------------------------------------- /tests/roots/test-html_assets/static/index.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/static/index.rst -------------------------------------------------------------------------------- /tests/roots/test-html_assets/static/js/custom.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/static/js/custom.js -------------------------------------------------------------------------------- /tests/roots/test-html_assets/static/rimg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/static/rimg.png -------------------------------------------------------------------------------- /tests/roots/test-html_assets/static/subdir/.htaccess: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/static/subdir/.htaccess -------------------------------------------------------------------------------- /tests/roots/test-html_assets/static/subdir/.htpasswd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/static/subdir/.htpasswd -------------------------------------------------------------------------------- /tests/roots/test-html_assets/subdir/_build/index.html: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/subdir/_build/index.html -------------------------------------------------------------------------------- /tests/roots/test-html_assets/subdir/background.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_assets/subdir/background.png -------------------------------------------------------------------------------- /tests/roots/test-html_entity/conf.py: -------------------------------------------------------------------------------- 1 | html_theme = 'classic' 2 | exclude_patterns = ['_build'] 3 | -------------------------------------------------------------------------------- /tests/roots/test-html_file_checksum/conf.py: -------------------------------------------------------------------------------- 1 | html_static_path = ['static'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-html_file_checksum/index.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_file_checksum/index.rst -------------------------------------------------------------------------------- /tests/roots/test-html_file_checksum/static/empty.js: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_file_checksum/static/empty.js -------------------------------------------------------------------------------- /tests/roots/test-html_file_checksum/static/script.js: -------------------------------------------------------------------------------- 1 | /* Script */ 2 | -------------------------------------------------------------------------------- /tests/roots/test-html_file_checksum/static/stylesheet-a.css: -------------------------------------------------------------------------------- 1 | /* Stylesheet A */ 2 | -------------------------------------------------------------------------------- /tests/roots/test-html_file_checksum/static/stylesheet-b.css: -------------------------------------------------------------------------------- 1 | /* Stylesheet B */ 2 | -------------------------------------------------------------------------------- /tests/roots/test-html_scaled_image_link/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_scaled_image_link/conf.py -------------------------------------------------------------------------------- /tests/roots/test-html_scaled_image_link/img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_scaled_image_link/img.png -------------------------------------------------------------------------------- /tests/roots/test-html_scaled_image_link/index.rst: -------------------------------------------------------------------------------- 1 | test-html_scaled_image_link 2 | =========================== 3 | 4 | .. image:: img.png 5 | 6 | .. image:: img.png 7 | :scale: 50% 8 | 9 | .. image:: img.png 10 | :scale: 50% 11 | :class: no-scaled-link 12 | -------------------------------------------------------------------------------- /tests/roots/test-html_signaturereturn_icon/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.autodoc'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-html_signaturereturn_icon/index.rst: -------------------------------------------------------------------------------- 1 | test-html_signaturereturn_icon 2 | ============================== 3 | 4 | .. py:function:: foo(a: bool, b: int) -> str 5 | -------------------------------------------------------------------------------- /tests/roots/test-html_style/_static/default.css: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-html_style/_static/default.css -------------------------------------------------------------------------------- /tests/roots/test-html_style/conf.py: -------------------------------------------------------------------------------- 1 | html_style = 'default.css' 2 | html_static_path = ['_static'] 3 | -------------------------------------------------------------------------------- /tests/roots/test-html_style/index.rst: -------------------------------------------------------------------------------- 1 | html_style 2 | ========== 3 | -------------------------------------------------------------------------------- /tests/roots/test-image-escape/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-image-escape/conf.py -------------------------------------------------------------------------------- /tests/roots/test-image-escape/img_#1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-image-escape/img_#1.png -------------------------------------------------------------------------------- /tests/roots/test-image-escape/index.rst: -------------------------------------------------------------------------------- 1 | Sphinx image handling 2 | ===================== 3 | 4 | .. an image with a character that is valid in a local file path but not a URL 5 | .. image:: img_#1.png 6 | -------------------------------------------------------------------------------- /tests/roots/test-image-in-parsed-literal/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | 3 | rst_epilog = """ 4 | .. |picture| image:: pic.png 5 | :height: 1cm 6 | :scale: 200% 7 | :align: middle 8 | :alt: alternative_text 9 | """ 10 | -------------------------------------------------------------------------------- /tests/roots/test-image-in-parsed-literal/index.rst: -------------------------------------------------------------------------------- 1 | test-image-in-parsed-literal 2 | ============================ 3 | 4 | Dummy text 5 | 6 | .. parsed-literal:: 7 | 8 | |picture|\ AFTER 9 | 10 | -------------------------------------------------------------------------------- /tests/roots/test-image-in-parsed-literal/pic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-image-in-parsed-literal/pic.png -------------------------------------------------------------------------------- /tests/roots/test-image-in-section/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | 3 | rst_epilog = """ 4 | .. |picture| image:: pic.png 5 | :width: 15pt 6 | :height: 15pt 7 | :alt: alternative_text 8 | """ 9 | -------------------------------------------------------------------------------- /tests/roots/test-image-in-section/pic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-image-in-section/pic.png -------------------------------------------------------------------------------- /tests/roots/test-images/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/conf.py -------------------------------------------------------------------------------- /tests/roots/test-images/img.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/img.gif -------------------------------------------------------------------------------- /tests/roots/test-images/img.ja.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/img.ja.png -------------------------------------------------------------------------------- /tests/roots/test-images/img.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/img.pdf -------------------------------------------------------------------------------- /tests/roots/test-images/img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/img.png -------------------------------------------------------------------------------- /tests/roots/test-images/img.zh.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/img.zh.png -------------------------------------------------------------------------------- /tests/roots/test-images/rimg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/rimg.png -------------------------------------------------------------------------------- /tests/roots/test-images/rimg.png.xx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/rimg.png.xx -------------------------------------------------------------------------------- /tests/roots/test-images/rimg.xx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/rimg.xx.png -------------------------------------------------------------------------------- /tests/roots/test-images/subdir/index.rst: -------------------------------------------------------------------------------- 1 | test-images/subdir 2 | ================== 3 | 4 | .. image:: rimg.png 5 | 6 | .. image:: svgimg.* 7 | 8 | .. figure:: svgimg.* 9 | 10 | The caption of svgimg 11 | -------------------------------------------------------------------------------- /tests/roots/test-images/subdir/rimg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/subdir/rimg.png -------------------------------------------------------------------------------- /tests/roots/test-images/subdir/rimg.xx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/subdir/rimg.xx.png -------------------------------------------------------------------------------- /tests/roots/test-images/subdir/svgimg.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/subdir/svgimg.pdf -------------------------------------------------------------------------------- /tests/roots/test-images/testimäge.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-images/testimäge.png -------------------------------------------------------------------------------- /tests/roots/test-index_on_title/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-index_on_title/conf.py -------------------------------------------------------------------------------- /tests/roots/test-index_on_title/contents.rst: -------------------------------------------------------------------------------- 1 | index_on_title 2 | ============== 3 | 4 | Test for :index:`index` in top level title 5 | ------------------------------------------ 6 | -------------------------------------------------------------------------------- /tests/roots/test-inheritance/basic_diagram.rst: -------------------------------------------------------------------------------- 1 | Basic Diagram 2 | ============== 3 | 4 | .. inheritance-diagram:: 5 | dummy.test 6 | -------------------------------------------------------------------------------- /tests/roots/test-inheritance/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.inheritance_diagram'] 7 | -------------------------------------------------------------------------------- /tests/roots/test-inheritance/diagram_module_w_2_top_classes.rst: -------------------------------------------------------------------------------- 1 | Diagram using module with 2 top classes 2 | ======================================= 3 | 4 | .. inheritance-diagram:: 5 | dummy.test 6 | :top-classes: dummy.test.B, dummy.test.C 7 | -------------------------------------------------------------------------------- /tests/roots/test-inheritance/diagram_w_1_top_class.rst: -------------------------------------------------------------------------------- 1 | Diagram using 1 top class 2 | ========================= 3 | 4 | .. inheritance-diagram:: 5 | dummy.test 6 | :top-classes: dummy.test.B 7 | 8 | -------------------------------------------------------------------------------- /tests/roots/test-inheritance/diagram_w_nested_classes.rst: -------------------------------------------------------------------------------- 1 | Diagram with Nested Classes 2 | =========================== 3 | 4 | .. inheritance-diagram:: 5 | dummy.test_nested 6 | -------------------------------------------------------------------------------- /tests/roots/test-inheritance/diagram_w_parts.rst: -------------------------------------------------------------------------------- 1 | Diagram using the parts option 2 | ============================== 3 | 4 | .. inheritance-diagram:: 5 | dummy.test 6 | :parts: 1 7 | 8 | -------------------------------------------------------------------------------- /tests/roots/test-inheritance/dummy/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-inheritance/dummy/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-inheritance/dummy/test_nested.py: -------------------------------------------------------------------------------- 1 | """Test with nested classes.""" 2 | 3 | 4 | class A: 5 | class B: # NoQA: D106 6 | pass 7 | 8 | 9 | class C(A.B): 10 | pass 11 | -------------------------------------------------------------------------------- /tests/roots/test-inheritance/index.rst: -------------------------------------------------------------------------------- 1 | .. toctree:: 2 | :glob: 3 | 4 | * 5 | -------------------------------------------------------------------------------- /tests/roots/test-intl/bom.txt: -------------------------------------------------------------------------------- 1 | File with UTF-8 BOM 2 | =================== 3 | 4 | This file has a UTF-8 "BOM". 5 | 6 | -------------------------------------------------------------------------------- /tests/roots/test-intl/glossary_terms_inconsistency.txt: -------------------------------------------------------------------------------- 1 | :tocdepth: 2 2 | 3 | i18n with glossary terms inconsistency 4 | ====================================== 5 | 6 | 1. link to :term:`Some term` and :term:`Some other term`. 7 | 2. link to :term:`Some term`. 8 | -------------------------------------------------------------------------------- /tests/roots/test-intl/i18n.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-intl/i18n.png -------------------------------------------------------------------------------- /tests/roots/test-intl/img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-intl/img.png -------------------------------------------------------------------------------- /tests/roots/test-intl/markup.txt: -------------------------------------------------------------------------------- 1 | i18n with strange markup 2 | ======================== 3 | 4 | 1. title starting with 1. 5 | ------------------------- 6 | 7 | -------------------------------------------------------------------------------- /tests/roots/test-intl/only.txt: -------------------------------------------------------------------------------- 1 | Only directive 2 | -------------- 3 | 4 | .. only:: html 5 | 6 | In HTML. 7 | 8 | .. only:: latex 9 | 10 | In LaTeX. 11 | 12 | .. only:: html or latex 13 | 14 | In both. 15 | -------------------------------------------------------------------------------- /tests/roots/test-intl/raw.txt: -------------------------------------------------------------------------------- 1 | === 2 | Raw 3 | === 4 | 5 | .. raw:: html 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /tests/roots/test-intl/rubric.txt: -------------------------------------------------------------------------------- 1 | :tocdepth: 2 2 | 3 | i18n with rubric 4 | ================ 5 | 6 | .. rubric:: rubric title 7 | 8 | rubric in the block 9 | ------------------- 10 | 11 | block 12 | 13 | .. rubric:: rubric title 14 | 15 | -------------------------------------------------------------------------------- /tests/roots/test-intl/section.txt: -------------------------------------------------------------------------------- 1 | 1. Section 2 | ========== 3 | 4 | .. contents:: 3. Contents Title 5 | :local: 6 | 7 | 2. Sub Section 8 | -------------- 9 | -------------------------------------------------------------------------------- /tests/roots/test-intl/subdir/index.txt: -------------------------------------------------------------------------------- 1 | subdir contents 2 | =============== 3 | -------------------------------------------------------------------------------- /tests/roots/test-intl/toctree.txt: -------------------------------------------------------------------------------- 1 | i18n with toctree 2 | ================= 3 | 4 | .. toctree:: 5 | :caption: caption 6 | 7 | figure
8 | table 9 | https://www.sphinx-doc.org/ 10 | self 11 | -------------------------------------------------------------------------------- /tests/roots/test-intl/topic.txt: -------------------------------------------------------------------------------- 1 | :tocdepth: 2 2 | 3 | i18n with topic 4 | ================ 5 | 6 | .. topic:: Topic Title 7 | 8 | Topic Content 9 | 10 | .. topic:: 1. Topic Title 11 | 12 | Topic Content 13 | 14 | -------------------------------------------------------------------------------- /tests/roots/test-intl/warnings.txt: -------------------------------------------------------------------------------- 1 | i18n with reST warnings 2 | ======================== 3 | 4 | line of ``literal`` markup. 5 | 6 | -------------------------------------------------------------------------------- /tests/roots/test-intl_substitution_definitions/i18n.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-intl_substitution_definitions/i18n.png -------------------------------------------------------------------------------- /tests/roots/test-intl_substitution_definitions/img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-intl_substitution_definitions/img.png -------------------------------------------------------------------------------- /tests/roots/test-intl_substitution_definitions/index.rst: -------------------------------------------------------------------------------- 1 | CONTENTS 2 | ======== 3 | 4 | .. toctree:: 5 | :maxdepth: 2 6 | :numbered: 7 | :caption: Table of Contents 8 | 9 | prolog_epilog_substitution 10 | prolog_epilog_substitution_excluded 11 | -------------------------------------------------------------------------------- /tests/roots/test-keep_warnings/conf.py: -------------------------------------------------------------------------------- 1 | keep_warnings = True 2 | -------------------------------------------------------------------------------- /tests/roots/test-keep_warnings/index.rst: -------------------------------------------------------------------------------- 1 | keep_warnings 2 | ===== 3 | -------------------------------------------------------------------------------- /tests/roots/test-latex-babel/bar.rst: -------------------------------------------------------------------------------- 1 | === 2 | Bar 3 | === 4 | 5 | -------------------------------------------------------------------------------- /tests/roots/test-latex-babel/conf.py: -------------------------------------------------------------------------------- 1 | numfig_format = { 2 | 'figure': 'Fig. %s', 3 | 'table': 'Table. %s', 4 | 'code-block': 'List.', 5 | } 6 | -------------------------------------------------------------------------------- /tests/roots/test-latex-babel/foo.rst: -------------------------------------------------------------------------------- 1 | === 2 | Foo 3 | === 4 | 5 | -------------------------------------------------------------------------------- /tests/roots/test-latex-babel/index.rst: -------------------------------------------------------------------------------- 1 | test-tocdepth 2 | ============= 3 | 4 | .. toctree:: 5 | :caption: Table of content 6 | 7 | foo 8 | bar 9 | -------------------------------------------------------------------------------- /tests/roots/test-latex-container/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-latex-container/conf.py -------------------------------------------------------------------------------- /tests/roots/test-latex-container/index.rst: -------------------------------------------------------------------------------- 1 | .. container:: classname 2 | 3 | text 4 | -------------------------------------------------------------------------------- /tests/roots/test-latex-contents-topic-sidebar/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-latex-contents-topic-sidebar/conf.py -------------------------------------------------------------------------------- /tests/roots/test-latex-equations/conf.py: -------------------------------------------------------------------------------- 1 | root_doc = 'equations' 2 | extensions = ['sphinx.ext.imgmath'] 3 | -------------------------------------------------------------------------------- /tests/roots/test-latex-figure-in-admonition/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.todo'] 2 | todo_include_todos = True 3 | exclude_patterns = ['_build'] 4 | -------------------------------------------------------------------------------- /tests/roots/test-latex-figure-in-admonition/img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-latex-figure-in-admonition/img.png -------------------------------------------------------------------------------- /tests/roots/test-latex-includegraphics/img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-latex-includegraphics/img.png -------------------------------------------------------------------------------- /tests/roots/test-latex-includegraphics/sphinx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-latex-includegraphics/sphinx.png -------------------------------------------------------------------------------- /tests/roots/test-latex-includegraphics/tall.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-latex-includegraphics/tall.png -------------------------------------------------------------------------------- /tests/roots/test-latex-index/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-latex-index/conf.py -------------------------------------------------------------------------------- /tests/roots/test-latex-labels-before-module/automodule1.py: -------------------------------------------------------------------------------- 1 | """docstring""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-latex-labels-before-module/automodule2a.py: -------------------------------------------------------------------------------- 1 | """docstring""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-latex-labels-before-module/automodule2b.py: -------------------------------------------------------------------------------- 1 | """docstring""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-latex-labels-before-module/automodule3.py: -------------------------------------------------------------------------------- 1 | """docstring""" 2 | -------------------------------------------------------------------------------- /tests/roots/test-latex-labels-before-module/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autodoc'] 7 | 8 | nitpicky = True 9 | -------------------------------------------------------------------------------- /tests/roots/test-latex-labels/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-latex-labels/conf.py -------------------------------------------------------------------------------- /tests/roots/test-latex-labels/otherdoc.rst: -------------------------------------------------------------------------------- 1 | otherdoc 2 | ======== 3 | -------------------------------------------------------------------------------- /tests/roots/test-latex-numfig/index.rst: -------------------------------------------------------------------------------- 1 | ================= 2 | test-latex-numfig 3 | ================= 4 | 5 | .. toctree:: 6 | :numbered: 7 | 8 | indexmanual 9 | indexhowto 10 | -------------------------------------------------------------------------------- /tests/roots/test-latex-numfig/indexhowto.rst: -------------------------------------------------------------------------------- 1 | ======================= 2 | test-latex-numfig-howto 3 | ======================= 4 | 5 | This is a part 6 | ============== 7 | 8 | This is a section 9 | ----------------- 10 | 11 | -------------------------------------------------------------------------------- /tests/roots/test-latex-numfig/indexmanual.rst: -------------------------------------------------------------------------------- 1 | ======================== 2 | test-latex-numfig-manual 3 | ======================== 4 | 5 | First part 6 | ========== 7 | 8 | This is chapter 9 | --------------- 10 | 11 | This is section 12 | ~~~~~~~~~~~~~~~ 13 | 14 | -------------------------------------------------------------------------------- /tests/roots/test-latex-table/_mytemplates/latex/longtable.tex.jinja: -------------------------------------------------------------------------------- 1 | SALUT LES COPAINS 2 | -------------------------------------------------------------------------------- /tests/roots/test-latex-table/_mytemplates/latex/tabulary.tex_t: -------------------------------------------------------------------------------- 1 | AU REVOIR, KANIGGETS 2 | -------------------------------------------------------------------------------- /tests/roots/test-latex-table/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-latex-table/conf.py -------------------------------------------------------------------------------- /tests/roots/test-latex-table/index.rst: -------------------------------------------------------------------------------- 1 | test-latex-table 2 | ================ 3 | 4 | .. toctree:: 5 | 6 | tabular 7 | longtable 8 | complex 9 | -------------------------------------------------------------------------------- /tests/roots/test-latex-theme/conf.py: -------------------------------------------------------------------------------- 1 | latex_theme = 'custom' 2 | latex_theme_path = ['theme'] 3 | -------------------------------------------------------------------------------- /tests/roots/test-latex-theme/index.rst: -------------------------------------------------------------------------------- 1 | latex_theme 2 | =========== 3 | -------------------------------------------------------------------------------- /tests/roots/test-latex-theme/theme/custom/theme.conf: -------------------------------------------------------------------------------- 1 | [theme] 2 | docclass = book 3 | wrapperclass = sphinxbook 4 | papersize = a4paper 5 | pointsize = 12pt 6 | toplevel_sectioning = chapter 7 | -------------------------------------------------------------------------------- /tests/roots/test-latex-title/conf.py: -------------------------------------------------------------------------------- 1 | # set empty string to the third column to use the first section title to document title 2 | latex_documents = [ 3 | ('index', 'test.tex', '', 'Sphinx', 'report'), 4 | ] 5 | -------------------------------------------------------------------------------- /tests/roots/test-latex-title/index.rst: -------------------------------------------------------------------------------- 1 | .. admonition:: Notice 2 | 3 | This generates nodes.title node before first section title. 4 | 5 | test-latex-title 6 | ================ 7 | 8 | .. toctree:: 9 | :numbered: 10 | 11 | foo 12 | bar 13 | -------------------------------------------------------------------------------- /tests/roots/test-latex-unicode/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-latex-unicode/conf.py -------------------------------------------------------------------------------- /tests/roots/test-latex-unicode/index.rst: -------------------------------------------------------------------------------- 1 | test-latex-unicode 2 | ================== 3 | 4 | * script small e: ℯ 5 | * double struck italic small i: ⅈ 6 | * superscript: ⁰, ¹ 7 | * subscript: ₀, ₁ 8 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-anchors-ignore-for-url/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | linkcheck_anchors = True 3 | linkcheck_timeout = 0.25 4 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-anchors-ignore/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | linkcheck_anchors = True 3 | linkcheck_timeout = 0.25 4 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-anchors-ignore/index.rst: -------------------------------------------------------------------------------- 1 | * `Example Bar invalid `_ 2 | * `Example Bar invalid `_ 3 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-documents_exclude/br0ken_link.rst: -------------------------------------------------------------------------------- 1 | Broken link 2 | =========== 3 | 4 | Some links are `broken `__ 5 | but sometimes not worrying about some broken links is a valid strategy. 6 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-documents_exclude/broken_link.rst: -------------------------------------------------------------------------------- 1 | Broken link 2 | =========== 3 | 4 | Some links are `broken `__ 5 | but sometimes not worrying about some broken links is a valid strategy. 6 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-documents_exclude/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | linkcheck_exclude_documents = [ 3 | '^broken_link$', 4 | 'br[0-9]ken_link', 5 | ] 6 | linkcheck_timeout = 0.25 7 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-documents_exclude/index.rst: -------------------------------------------------------------------------------- 1 | .. toctree:: 2 | broken_link 3 | br0ken_link -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-localserver-anchor/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | linkcheck_anchors = True 3 | linkcheck_timeout = 0.25 4 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-localserver-anchor/index.rst: -------------------------------------------------------------------------------- 1 | `local server `_ 2 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-localserver-https/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | linkcheck_timeout = 0.25 3 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-localserver-https/index.rst: -------------------------------------------------------------------------------- 1 | `HTTPS server `_ 2 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-localserver-warn-redirects/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | linkcheck_timeout = 0.25 3 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-localserver-warn-redirects/index.rst: -------------------------------------------------------------------------------- 1 | `local server1 `_ 2 | 3 | `local server2 `_ 4 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-localserver/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | linkcheck_timeout = 0.25 3 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-localserver/index.rst: -------------------------------------------------------------------------------- 1 | `local server `_ 2 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-raw-node/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | linkcheck_timeout = 0.25 3 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-too-many-retries/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | linkcheck_anchors = True 3 | linkcheck_timeout = 0.25 4 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck-too-many-retries/index.rst: -------------------------------------------------------------------------------- 1 | `Non-existing uri with localhost `_ 2 | -------------------------------------------------------------------------------- /tests/roots/test-linkcheck/conf.py: -------------------------------------------------------------------------------- 1 | root_doc = 'links' 2 | exclude_patterns = ['_build'] 3 | linkcheck_anchors = True 4 | linkcheck_timeout = 0.25 5 | -------------------------------------------------------------------------------- /tests/roots/test-local-logo/conf.py: -------------------------------------------------------------------------------- 1 | latex_documents = [ 2 | ( 3 | 'index', 4 | 'test.tex', 5 | 'The basic Sphinx documentation for testing', 6 | 'Sphinx', 7 | 'report', 8 | ) 9 | ] 10 | html_logo = 'images/img.png' 11 | -------------------------------------------------------------------------------- /tests/roots/test-local-logo/images/img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-local-logo/images/img.png -------------------------------------------------------------------------------- /tests/roots/test-locale/locale1/en/LC_MESSAGES/myext.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-locale/locale1/en/LC_MESSAGES/myext.mo -------------------------------------------------------------------------------- /tests/roots/test-locale/locale1/en/LC_MESSAGES/myext.po: -------------------------------------------------------------------------------- 1 | msgid "Hello world" 2 | msgstr "HELLO WORLD" 3 | -------------------------------------------------------------------------------- /tests/roots/test-locale/locale1/et/LC_MESSAGES/myext.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-locale/locale1/et/LC_MESSAGES/myext.mo -------------------------------------------------------------------------------- /tests/roots/test-locale/locale1/et/LC_MESSAGES/myext.po: -------------------------------------------------------------------------------- 1 | msgid "Hello world" 2 | msgstr "Tere maailm" 3 | -------------------------------------------------------------------------------- /tests/roots/test-locale/locale2/en/LC_MESSAGES/myext.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-locale/locale2/en/LC_MESSAGES/myext.mo -------------------------------------------------------------------------------- /tests/roots/test-locale/locale2/en/LC_MESSAGES/myext.po: -------------------------------------------------------------------------------- 1 | msgid "Hello sphinx" 2 | msgstr "HELLO SPHINX" 3 | -------------------------------------------------------------------------------- /tests/roots/test-manpage_url/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-manpage_url/index.rst: -------------------------------------------------------------------------------- 1 | The :manpage:`cp(1)` 2 | -------------------- 3 | * :manpage:`man(1)` 4 | * :manpage:`ls.1` 5 | * :manpage:`sphinx` 6 | * :manpage:`mailx(1) ` 7 | * :manpage:`!man(1)` 8 | -------------------------------------------------------------------------------- /tests/roots/test-markup-citation/conf.py: -------------------------------------------------------------------------------- 1 | latex_documents = [ 2 | ( 3 | 'index', 4 | 'test.tex', 5 | 'The basic Sphinx documentation for testing', 6 | 'Sphinx', 7 | 'report', 8 | ) 9 | ] 10 | -------------------------------------------------------------------------------- /tests/roots/test-markup-citation/index.rst: -------------------------------------------------------------------------------- 1 | test-markup-citation 2 | ===================== 3 | 4 | This is a citation ref; [CITE1]_ and [CITE2]_. 5 | 6 | .. [CITE1] This is a citation 7 | 8 | .. [CITE2] This is 9 | a multiline citation 10 | -------------------------------------------------------------------------------- /tests/roots/test-maxlistdepth/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | 3 | latex_elements = { 4 | 'maxlistdepth': '10', 5 | } 6 | -------------------------------------------------------------------------------- /tests/roots/test-metadata/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-metadata/conf.py -------------------------------------------------------------------------------- /tests/roots/test-need-escaped/bar.rst: -------------------------------------------------------------------------------- 1 | bar 2 | === 3 | -------------------------------------------------------------------------------- /tests/roots/test-need-escaped/baz.rst: -------------------------------------------------------------------------------- 1 | baz 2 | === 3 | -------------------------------------------------------------------------------- /tests/roots/test-need-escaped/conf.py: -------------------------------------------------------------------------------- 1 | project = 'need "escaped" project' 2 | smartquotes = False 3 | -------------------------------------------------------------------------------- /tests/roots/test-need-escaped/foo.rst: -------------------------------------------------------------------------------- 1 | 2 | ===== 3 | 4 | .. toctree:: 5 | 6 | quux 7 | 8 | foo "1" 9 | ------- 10 | 11 | foo.1-1 12 | ^^^^^^^ 13 | 14 | foo.2 15 | ----- 16 | -------------------------------------------------------------------------------- /tests/roots/test-need-escaped/quux.rst: -------------------------------------------------------------------------------- 1 | quux 2 | ==== 3 | -------------------------------------------------------------------------------- /tests/roots/test-need-escaped/qux.rst: -------------------------------------------------------------------------------- 1 | qux.rst has no section title 2 | -------------------------------------------------------------------------------- /tests/roots/test-nested-enumerated-list/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-nested-enumerated-list/conf.py -------------------------------------------------------------------------------- /tests/roots/test-nested-tables/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-nested-tables/conf.py -------------------------------------------------------------------------------- /tests/roots/test-nitpicky-warnings/conf.py: -------------------------------------------------------------------------------- 1 | nitpicky = True 2 | -------------------------------------------------------------------------------- /tests/roots/test-nitpicky-warnings/index.rst: -------------------------------------------------------------------------------- 1 | test-nitpicky-warnings 2 | ====================== 3 | 4 | :py:const:`prefix.anything.postfix` 5 | :py:class:`prefix.anything` 6 | :py:class:`anything.postfix` 7 | :js:class:`prefix.anything.postfix` 8 | -------------------------------------------------------------------------------- /tests/roots/test-numbered-circular/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-numbered-circular/index.rst: -------------------------------------------------------------------------------- 1 | .. toctree:: 2 | :numbered: 3 | 4 | sub 5 | 6 | -------------------------------------------------------------------------------- /tests/roots/test-numbered-circular/sub.rst: -------------------------------------------------------------------------------- 1 | .. toctree:: 2 | 3 | index 4 | -------------------------------------------------------------------------------- /tests/roots/test-numfig/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-numfig/rimg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-numfig/rimg.png -------------------------------------------------------------------------------- /tests/roots/test-object-description-sections/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-object-description-sections/conf.py -------------------------------------------------------------------------------- /tests/roots/test-object-description-sections/index.rst: -------------------------------------------------------------------------------- 1 | .. py:function:: func() 2 | 3 | Overview 4 | -------- 5 | 6 | Lorem ipsum dolar sit amet 7 | -------------------------------------------------------------------------------- /tests/roots/test-productionlist/Bare.rst: -------------------------------------------------------------------------------- 1 | Bare 2 | ==== 3 | 4 | .. productionlist:: 5 | A: `A` | somethingA 6 | B: `B` | somethingB 7 | -------------------------------------------------------------------------------- /tests/roots/test-productionlist/Dup1.rst: -------------------------------------------------------------------------------- 1 | Dup1 2 | ==== 3 | 4 | .. productionlist:: 5 | Dup: `Dup` | somethingDup 6 | -------------------------------------------------------------------------------- /tests/roots/test-productionlist/Dup2.rst: -------------------------------------------------------------------------------- 1 | Dup2 2 | ==== 3 | 4 | .. productionlist:: 5 | Dup: `Dup` | somethingDup 6 | -------------------------------------------------------------------------------- /tests/roots/test-productionlist/LineContinuation.rst: -------------------------------------------------------------------------------- 1 | LineContinuation 2 | ================ 3 | 4 | .. productionlist:: lineContinuation 5 | A: B C D \ 6 | E F G 7 | -------------------------------------------------------------------------------- /tests/roots/test-productionlist/P1.rst: -------------------------------------------------------------------------------- 1 | P1 2 | == 3 | 4 | .. productionlist:: P1 5 | A: `A` | somethingA 6 | B: `B` | somethingB 7 | -------------------------------------------------------------------------------- /tests/roots/test-productionlist/P2.rst: -------------------------------------------------------------------------------- 1 | P2 2 | == 3 | 4 | .. productionlist:: P2 5 | A: `A` | somethingA 6 | B: `B` | somethingB 7 | -------------------------------------------------------------------------------- /tests/roots/test-productionlist/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-productionlist/firstLineRule.rst: -------------------------------------------------------------------------------- 1 | FirstLineRule 2 | ============= 3 | 4 | .. productionlist:: FirstLine: something 5 | SecondLine: somethingElse 6 | -------------------------------------------------------------------------------- /tests/roots/test-prolog/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['prolog_markdown_parser'] 7 | 8 | rst_prolog = '*Hello world*.\n\n' 9 | rst_epilog = '\n\n*Good-bye world*.' 10 | -------------------------------------------------------------------------------- /tests/roots/test-prolog/index.rst: -------------------------------------------------------------------------------- 1 | prolog and epilog 2 | ================= 3 | 4 | .. toctree:: 5 | 6 | restructuredtext 7 | markdown 8 | -------------------------------------------------------------------------------- /tests/roots/test-prolog/markdown.md: -------------------------------------------------------------------------------- 1 | # sample document 2 | 3 | This is a sample document in markdown 4 | -------------------------------------------------------------------------------- /tests/roots/test-prolog/restructuredtext.rst: -------------------------------------------------------------------------------- 1 | sample document 2 | =============== 3 | 4 | This is a sample document in reST 5 | -------------------------------------------------------------------------------- /tests/roots/test-pycode/cp_1251_coded.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-pycode/cp_1251_coded.py -------------------------------------------------------------------------------- /tests/roots/test-reST-code-block/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-reST-code-block/conf.py -------------------------------------------------------------------------------- /tests/roots/test-reST-code-block/index.rst: -------------------------------------------------------------------------------- 1 | .. code-block:: 2 | :linenos: 3 | 4 | def hello(name) 5 | print("hello", name) 6 | 7 | hello("Sphinx") 8 | -------------------------------------------------------------------------------- /tests/roots/test-reST-code-role/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-reST-code-role/conf.py -------------------------------------------------------------------------------- /tests/roots/test-refonly_bullet_list/conf.py: -------------------------------------------------------------------------------- 1 | html_compact_lists = False 2 | -------------------------------------------------------------------------------- /tests/roots/test-refonly_bullet_list/index.rst: -------------------------------------------------------------------------------- 1 | test-refonly_bullet_list 2 | ======================== 3 | 4 | List A: 5 | 6 | * :ref:`genindex` 7 | * :ref:`modindex` 8 | * :ref:`search` 9 | 10 | List B: 11 | 12 | * Hello 13 | * Sphinx 14 | * World 15 | -------------------------------------------------------------------------------- /tests/roots/test-roles-download/another/dummy.dat: -------------------------------------------------------------------------------- 1 | this one will have some content 2 | -------------------------------------------------------------------------------- /tests/roots/test-roles-download/conf.py: -------------------------------------------------------------------------------- 1 | latex_documents = [ 2 | ( 3 | 'index', 4 | 'test.tex', 5 | 'The basic Sphinx documentation for testing', 6 | 'Sphinx', 7 | 'report', 8 | ) 9 | ] 10 | -------------------------------------------------------------------------------- /tests/roots/test-roles-download/dummy.dat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-roles-download/dummy.dat -------------------------------------------------------------------------------- /tests/roots/test-root/_templates/contentssb.html: -------------------------------------------------------------------------------- 1 | {# sidebar only for contents document #} 2 |

Contents sidebar

3 | -------------------------------------------------------------------------------- /tests/roots/test-root/_templates/customsb.html: -------------------------------------------------------------------------------- 1 | {# custom sidebar template #} 2 |

Custom sidebar

3 | 4 | {{ toctree(titles_only=True, maxdepth=1) }} 5 | -------------------------------------------------------------------------------- /tests/roots/test-root/bom.txt: -------------------------------------------------------------------------------- 1 | File with UTF-8 BOM 2 | =================== 3 | 4 | This file has a UTF-8 "BOM". 5 | 6 | -------------------------------------------------------------------------------- /tests/roots/test-root/extapi.txt: -------------------------------------------------------------------------------- 1 | Extension API tests 2 | =================== 3 | 4 | Testing directives: 5 | 6 | .. clsdir:: 7 | :opt: Bar 8 | -------------------------------------------------------------------------------- /tests/roots/test-root/file_with_special_#_chars.xyz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-root/file_with_special_#_chars.xyz -------------------------------------------------------------------------------- /tests/roots/test-root/img.foo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-root/img.foo.png -------------------------------------------------------------------------------- /tests/roots/test-root/img.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-root/img.gif -------------------------------------------------------------------------------- /tests/roots/test-root/img.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-root/img.pdf -------------------------------------------------------------------------------- /tests/roots/test-root/img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-root/img.png -------------------------------------------------------------------------------- /tests/roots/test-root/otherext.foo: -------------------------------------------------------------------------------- 1 | The contents of this file are ignored. 2 | The file is "parsed" using Parser in the tests/root/parsermod.py file. 3 | -------------------------------------------------------------------------------- /tests/roots/test-root/quotes.inc: -------------------------------------------------------------------------------- 1 | Testing "quotes" in literal 'included' text. 2 | -------------------------------------------------------------------------------- /tests/roots/test-root/rimg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-root/rimg.png -------------------------------------------------------------------------------- /tests/roots/test-root/special/api.h: -------------------------------------------------------------------------------- 1 | PyAPI_FUNC(PyObject *) Py_SphinxTest(void); 2 | PyAPI_FUNC(PyObject *) Py_SphinxFoo(void); 3 | -------------------------------------------------------------------------------- /tests/roots/test-root/special/code.py: -------------------------------------------------------------------------------- 1 | print('line 1') 2 | print('line 2') 3 | -------------------------------------------------------------------------------- /tests/roots/test-root/subdir/excluded.txt: -------------------------------------------------------------------------------- 1 | Excluded file -- should *not* be read as source 2 | ----------------------------------------------- 3 | -------------------------------------------------------------------------------- /tests/roots/test-root/subdir/images.txt: -------------------------------------------------------------------------------- 1 | Image including source in subdir 2 | ================================ 3 | 4 | .. image:: img.* 5 | 6 | .. image:: /rimg.png 7 | -------------------------------------------------------------------------------- /tests/roots/test-root/subdir/img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-root/subdir/img.png -------------------------------------------------------------------------------- /tests/roots/test-root/subdir/include.inc: -------------------------------------------------------------------------------- 1 | .. This file is included by contents.txt. 2 | 3 | .. Paths in included files are relative to the file that 4 | includes them 5 | .. image:: subdir/img.png 6 | -------------------------------------------------------------------------------- /tests/roots/test-root/subdir/simg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-root/subdir/simg.png -------------------------------------------------------------------------------- /tests/roots/test-root/svgimg.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-root/svgimg.pdf -------------------------------------------------------------------------------- /tests/roots/test-root/tabs.inc: -------------------------------------------------------------------------------- 1 | Tabs include file test 2 | ---------------------- 3 | 4 | The next line has a tab: 5 | -| |- 6 | -------------------------------------------------------------------------------- /tests/roots/test-root/test.inc: -------------------------------------------------------------------------------- 1 | .. This file is included from subdir/includes.txt. 2 | 3 | This is an include file. 4 | -------------------------------------------------------------------------------- /tests/roots/test-root/wrongenc.inc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-root/wrongenc.inc -------------------------------------------------------------------------------- /tests/roots/test-search/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | html_search_language = 'en' 3 | -------------------------------------------------------------------------------- /tests/roots/test-search/nosearch.rst: -------------------------------------------------------------------------------- 1 | :nosearch: 2 | 3 | nosearch 4 | ======== 5 | 6 | bat 7 | latex 8 | -------------------------------------------------------------------------------- /tests/roots/test-search/tocitem.rst: -------------------------------------------------------------------------------- 1 | heading 1 2 | ========= 3 | 4 | lorem ipsum 5 | 6 | bat 7 | 8 | textinheading 9 | ============= 10 | 11 | lorem ipsum 12 | 13 | 可以查看 FAQ 模块中 Chinesetest 部分 14 | 15 | 模块中 CAS service部分 16 | 17 | 可以Chinesetesttwo查看 18 | -------------------------------------------------------------------------------- /tests/roots/test-smartquotes/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-smartquotes/conf.py -------------------------------------------------------------------------------- /tests/roots/test-smartquotes/index.rst: -------------------------------------------------------------------------------- 1 | test-smartquotes 2 | ================ 3 | 4 | -- "Sphinx" is a tool that makes it easy ... 5 | 6 | .. toctree:: 7 | 8 | literals 9 | -------------------------------------------------------------------------------- /tests/roots/test-stylesheets/index.rst: -------------------------------------------------------------------------------- 1 | test-stylesheets 2 | ================ 3 | 4 | Lorem ipsum dolor 5 | -------------------------------------------------------------------------------- /tests/roots/test-templating/_templates/layout.html: -------------------------------------------------------------------------------- 1 | {% extends "!layout.html" %} 2 | 3 | {% block extrahead %} 4 | 5 | {{ super() }} 6 | {% endblock %} 7 | -------------------------------------------------------------------------------- /tests/roots/test-templating/autosummary_templating.txt: -------------------------------------------------------------------------------- 1 | Autosummary templating test 2 | =========================== 3 | 4 | .. autosummary:: 5 | :toctree: generated 6 | 7 | sphinx.application.TemplateBridge 8 | -------------------------------------------------------------------------------- /tests/roots/test-templating/index.txt: -------------------------------------------------------------------------------- 1 | Welcome to Sphinx Tests's documentation! 2 | ======================================== 3 | 4 | .. toctree:: 5 | 6 | autosummary_templating 7 | 8 | -------------------------------------------------------------------------------- /tests/roots/test-theming/child.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-theming/child.zip -------------------------------------------------------------------------------- /tests/roots/test-theming/conf.py: -------------------------------------------------------------------------------- 1 | html_theme = 'test-theme' 2 | html_theme_path = ['.', 'test_theme'] 3 | exclude_patterns = ['_build'] 4 | -------------------------------------------------------------------------------- /tests/roots/test-theming/index.rst: -------------------------------------------------------------------------------- 1 | ======= 2 | Theming 3 | ======= 4 | 5 | 6 | -------------------------------------------------------------------------------- /tests/roots/test-theming/parent.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-theming/parent.zip -------------------------------------------------------------------------------- /tests/roots/test-theming/test_theme/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-theming/test_theme/__init__.py -------------------------------------------------------------------------------- /tests/roots/test-theming/test_theme/staticfiles/layout.html: -------------------------------------------------------------------------------- 1 | {% extends "basic/layout.html" %} 2 | {% block extrahead %} 3 | 4 | {{ super() }} 5 | {% endblock %} 6 | -------------------------------------------------------------------------------- /tests/roots/test-theming/test_theme/staticfiles/static/legacytmpl.html_t: -------------------------------------------------------------------------------- 1 | 2 | {{ project | lower | escape }} 3 | -------------------------------------------------------------------------------- /tests/roots/test-theming/test_theme/staticfiles/static/staticimg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-theming/test_theme/staticfiles/static/staticimg.png -------------------------------------------------------------------------------- /tests/roots/test-theming/test_theme/staticfiles/static/statictmpl.html.jinja: -------------------------------------------------------------------------------- 1 | 2 | {{ project|e }} 3 | -------------------------------------------------------------------------------- /tests/roots/test-theming/test_theme/staticfiles/theme.conf: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = basic 3 | stylesheet = default.css 4 | pygments_style = emacs 5 | 6 | [options] 7 | testopt = optdefault 8 | -------------------------------------------------------------------------------- /tests/roots/test-theming/test_theme/test-theme/theme.conf: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = classic 3 | sidebars = globaltoc.html, searchbox.html 4 | pygments_dark_style = monokai 5 | -------------------------------------------------------------------------------- /tests/roots/test-theming/ziptheme.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-theming/ziptheme.zip -------------------------------------------------------------------------------- /tests/roots/test-tocdepth/baz.rst: -------------------------------------------------------------------------------- 1 | Baz A 2 | ----- 3 | 4 | should be 2.1.1 5 | 6 | -------------------------------------------------------------------------------- /tests/roots/test-tocdepth/conf.py: -------------------------------------------------------------------------------- 1 | html_theme = 'classic' 2 | exclude_patterns = ['_build'] 3 | -------------------------------------------------------------------------------- /tests/roots/test-tocdepth/index.rst: -------------------------------------------------------------------------------- 1 | test-tocdepth 2 | ============= 3 | 4 | .. toctree:: 5 | :numbered: 6 | 7 | foo 8 | bar 9 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-domain-objects/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-toctree-domain-objects/conf.py -------------------------------------------------------------------------------- /tests/roots/test-toctree-domain-objects/index.rst: -------------------------------------------------------------------------------- 1 | .. toctree:: 2 | :numbered: 3 | :caption: Table of Contents 4 | :name: mastertoc 5 | 6 | domains 7 | document_scoping 8 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-duplicated/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-toctree-duplicated/conf.py -------------------------------------------------------------------------------- /tests/roots/test-toctree-duplicated/foo.rst: -------------------------------------------------------------------------------- 1 | foo 2 | === 3 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-duplicated/index.rst: -------------------------------------------------------------------------------- 1 | test-toctree-duplicated 2 | ======================= 3 | 4 | .. toctree:: 5 | 6 | foo 7 | foo 8 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-empty/_templates/localtoc.html: -------------------------------------------------------------------------------- 1 | {# This will call toctree unconditionally, whether there is a local or global toc #} 2 | {{ toctree() }} 3 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-empty/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | templates_path = ['_templates'] 3 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-empty/index.rst: -------------------------------------------------------------------------------- 1 | test-toctree-empty 2 | ================== 3 | 4 | .. toctree:: 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/bar/bar_1.rst: -------------------------------------------------------------------------------- 1 | Bar-1 2 | ===== 3 | 4 | bar 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/bar/bar_2.rst: -------------------------------------------------------------------------------- 1 | Bar-2 2 | ===== 3 | 4 | bar 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/bar/bar_3.rst: -------------------------------------------------------------------------------- 1 | Bar-3 2 | ===== 3 | 4 | bar 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/bar/bar_4/index.rst: -------------------------------------------------------------------------------- 1 | Bar-4 2 | ===== 3 | 4 | bar 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/bar/index.rst: -------------------------------------------------------------------------------- 1 | Bar 2 | === 3 | 4 | .. toctree:: 5 | :glob: 6 | 7 | * 8 | bar_4/index 9 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/baz.rst: -------------------------------------------------------------------------------- 1 | Baz 2 | === 3 | 4 | baz 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/foo.rst: -------------------------------------------------------------------------------- 1 | Foo 2 | === 3 | 4 | foo 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/quux.rst: -------------------------------------------------------------------------------- 1 | Quux 2 | ==== 3 | 4 | quux 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/qux/index.rst: -------------------------------------------------------------------------------- 1 | Qux 2 | === 3 | 4 | .. toctree:: 5 | :glob: 6 | :hidden: 7 | 8 | * 9 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/qux/qux_1.rst: -------------------------------------------------------------------------------- 1 | Qux-1 2 | ===== 3 | 4 | qux 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-glob/qux/qux_2.rst: -------------------------------------------------------------------------------- 1 | Qux-1 2 | ===== 3 | 4 | qux 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-index/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-toctree-index/conf.py -------------------------------------------------------------------------------- /tests/roots/test-toctree-index/foo.rst: -------------------------------------------------------------------------------- 1 | foo 2 | === 3 | 4 | :index:`word` 5 | 6 | .. py:module:: pymodule 7 | 8 | .. py:function:: Timer.repeat(repeat=3, number=1000000) 9 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-index/index.rst: -------------------------------------------------------------------------------- 1 | test-toctree-index 2 | ================== 3 | 4 | .. toctree:: 5 | 6 | foo 7 | 8 | 9 | .. toctree:: 10 | :caption: Indices 11 | 12 | genindex 13 | modindex 14 | search 15 | 16 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-maxdepth/baz.rst: -------------------------------------------------------------------------------- 1 | Baz A 2 | ----- 3 | 4 | should be 2.1.1 5 | 6 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-maxdepth/conf.py: -------------------------------------------------------------------------------- 1 | exclude_patterns = ['_build'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-maxdepth/index.rst: -------------------------------------------------------------------------------- 1 | test-toctree-max-depth 2 | ====================== 3 | 4 | .. toctree:: 5 | :numbered: 6 | :maxdepth: 2 7 | 8 | foo 9 | bar 10 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-maxdepth/qux.rst: -------------------------------------------------------------------------------- 1 | test-toctree-max-depth 2 | ====================== 3 | 4 | .. toctree:: 5 | :numbered: 6 | :maxdepth: 4 7 | 8 | foo 9 | bar 10 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-multiple-parents/alpha.rst: -------------------------------------------------------------------------------- 1 | Alpha 2 | ===== 3 | 4 | .. literalinclude:: relation_graph.txt 5 | 6 | .. toctree:: 7 | bravo 8 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-multiple-parents/bravo.rst: -------------------------------------------------------------------------------- 1 | Bravo 2 | ===== 3 | 4 | .. literalinclude:: relation_graph.txt 5 | 6 | .. toctree:: 7 | charlie 8 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-multiple-parents/charlie.rst: -------------------------------------------------------------------------------- 1 | Charlie 2 | ======= 3 | 4 | .. literalinclude:: relation_graph.txt 5 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-multiple-parents/conf.py: -------------------------------------------------------------------------------- 1 | html_theme = 'basic' 2 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-multiple-parents/delta.rst: -------------------------------------------------------------------------------- 1 | Delta 2 | ===== 3 | 4 | .. literalinclude:: relation_graph.txt 5 | 6 | .. toctree:: 7 | charlie 8 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-multiple-parents/index.rst: -------------------------------------------------------------------------------- 1 | test-toctree-multiple-parents 2 | ============================= 3 | 4 | .. literalinclude:: relation_graph.txt 5 | 6 | .. toctree:: 7 | alpha 8 | delta 9 | -------------------------------------------------------------------------------- /tests/roots/test-toctree-multiple-parents/relation_graph.txt: -------------------------------------------------------------------------------- 1 | index 2 | / \ 3 | alpha delta 4 | \ / 5 | bravo / 6 | \ / 7 | charlie 8 | -------------------------------------------------------------------------------- /tests/roots/test-toctree/bar.rst: -------------------------------------------------------------------------------- 1 | bar 2 | === 3 | -------------------------------------------------------------------------------- /tests/roots/test-toctree/baz.rst: -------------------------------------------------------------------------------- 1 | baz 2 | === 3 | -------------------------------------------------------------------------------- /tests/roots/test-toctree/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-toctree/conf.py -------------------------------------------------------------------------------- /tests/roots/test-toctree/foo.rst: -------------------------------------------------------------------------------- 1 | foo 2 | === 3 | 4 | .. toctree:: 5 | 6 | quux 7 | 8 | foo.1 9 | ----- 10 | 11 | foo.1-1 12 | ^^^^^^^ 13 | 14 | foo.2 15 | ----- 16 | -------------------------------------------------------------------------------- /tests/roots/test-toctree/quux.rst: -------------------------------------------------------------------------------- 1 | quux 2 | ==== 3 | -------------------------------------------------------------------------------- /tests/roots/test-toctree/qux.rst: -------------------------------------------------------------------------------- 1 | qux.rst has no section title 2 | -------------------------------------------------------------------------------- /tests/roots/test-toctree/tocdepth.rst: -------------------------------------------------------------------------------- 1 | :tocdepth: 2 2 | 3 | ======= 4 | level 1 5 | ======= 6 | 7 | level 2 8 | ======= 9 | 10 | ------- 11 | level 3 12 | ------- 13 | 14 | level 4 15 | ------- 16 | -------------------------------------------------------------------------------- /tests/roots/test-transforms-post_transforms-keyboard/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-transforms-post_transforms-keyboard/conf.py -------------------------------------------------------------------------------- /tests/roots/test-transforms-post_transforms-keyboard/index.rst: -------------------------------------------------------------------------------- 1 | Regression test for KeyboardTransform iteration 2 | =============================================== 3 | .. https://github.com/sphinx-doc/sphinx/issues/10495 4 | 5 | :kbd:`spanish - inquisition` 6 | -------------------------------------------------------------------------------- /tests/roots/test-transforms-post_transforms-missing-reference/conf.py: -------------------------------------------------------------------------------- 1 | nitpicky = True 2 | -------------------------------------------------------------------------------- /tests/roots/test-transforms-post_transforms-missing-reference/index.rst: -------------------------------------------------------------------------------- 1 | transforms-post_transforms-missing-reference 2 | ============================================ 3 | 4 | :class:`io.StringIO` 5 | 6 | -------------------------------------------------------------------------------- /tests/roots/test-trim_doctest_flags/conf.py: -------------------------------------------------------------------------------- 1 | extensions = ['sphinx.ext.doctest'] 2 | -------------------------------------------------------------------------------- /tests/roots/test-util-copyasset_overwrite/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['myext'] 7 | html_static_path = ['user_static'] 8 | html_theme = 'basic' 9 | -------------------------------------------------------------------------------- /tests/roots/test-util-copyasset_overwrite/index.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-util-copyasset_overwrite/index.rst -------------------------------------------------------------------------------- /tests/roots/test-util-copyasset_overwrite/myext_static/custom-styles.css: -------------------------------------------------------------------------------- 1 | /* extension styles */ 2 | -------------------------------------------------------------------------------- /tests/roots/test-util-copyasset_overwrite/user_static/custom-styles.css: -------------------------------------------------------------------------------- 1 | /* html_static_path */ 2 | -------------------------------------------------------------------------------- /tests/roots/test-versioning/conf.py: -------------------------------------------------------------------------------- 1 | project = 'versioning test root' 2 | source_suffix = { 3 | '.txt': 'restructuredtext', 4 | } 5 | exclude_patterns = ['_build'] 6 | -------------------------------------------------------------------------------- /tests/roots/test-versioning/index.txt: -------------------------------------------------------------------------------- 1 | Versioning Stuff 2 | ================ 3 | 4 | .. toctree:: 5 | 6 | original 7 | added 8 | insert 9 | deleted 10 | deleted_end 11 | modified 12 | insert_beginning 13 | insert_similar 14 | -------------------------------------------------------------------------------- /tests/roots/test-warnings/autodoc_fodder.py: -------------------------------------------------------------------------------- 1 | class MarkupError: 2 | """.. note:: This is a docstring with a 3 | small markup error which should have 4 | correct location information. 5 | """ 6 | -------------------------------------------------------------------------------- /tests/roots/test-warnings/conf.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from pathlib import Path 3 | 4 | sys.path.insert(0, str(Path.cwd().resolve())) 5 | 6 | extensions = ['sphinx.ext.autodoc'] 7 | -------------------------------------------------------------------------------- /tests/roots/test-warnings/svgimg.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-warnings/svgimg.pdf -------------------------------------------------------------------------------- /tests/roots/test-warnings/undecodable.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-warnings/undecodable.rst -------------------------------------------------------------------------------- /tests/roots/test-warnings/wrongenc.inc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/roots/test-warnings/wrongenc.inc -------------------------------------------------------------------------------- /tests/test__cli/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test__cli/__init__.py -------------------------------------------------------------------------------- /tests/test_builders/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_builders/__init__.py -------------------------------------------------------------------------------- /tests/test_builders/xpath_data.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | from typing import TYPE_CHECKING 4 | 5 | if TYPE_CHECKING: 6 | from typing import Final 7 | 8 | FIGURE_CAPTION: Final[str] = './/figure/figcaption/p' 9 | -------------------------------------------------------------------------------- /tests/test_config/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_config/__init__.py -------------------------------------------------------------------------------- /tests/test_directives/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_directives/__init__.py -------------------------------------------------------------------------------- /tests/test_domains/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_domains/__init__.py -------------------------------------------------------------------------------- /tests/test_environment/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_environment/__init__.py -------------------------------------------------------------------------------- /tests/test_extensions/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_extensions/__init__.py -------------------------------------------------------------------------------- /tests/test_intl/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_intl/__init__.py -------------------------------------------------------------------------------- /tests/test_markup/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_markup/__init__.py -------------------------------------------------------------------------------- /tests/test_pycode/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_pycode/__init__.py -------------------------------------------------------------------------------- /tests/test_theming/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_theming/__init__.py -------------------------------------------------------------------------------- /tests/test_theming/theme.conf: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = none 3 | stylesheet = spam.css, ham.css 4 | pygments_style = spam 5 | 6 | [options] 7 | lobster = thermidor 8 | -------------------------------------------------------------------------------- /tests/test_theming/theme.toml: -------------------------------------------------------------------------------- 1 | [theme] 2 | inherit = "none" 3 | stylesheets = [ 4 | "spam.css", 5 | "ham.css", 6 | ] 7 | pygments_style = { default = "spam" } 8 | 9 | [options] 10 | lobster = "thermidor" 11 | -------------------------------------------------------------------------------- /tests/test_transforms/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_transforms/__init__.py -------------------------------------------------------------------------------- /tests/test_util/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_util/__init__.py -------------------------------------------------------------------------------- /tests/test_writers/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/tests/test_writers/__init__.py -------------------------------------------------------------------------------- /utils/CHANGES_template.rst: -------------------------------------------------------------------------------- 1 | Dependencies 2 | ------------ 3 | 4 | Incompatible changes 5 | -------------------- 6 | 7 | Deprecated 8 | ---------- 9 | 10 | Features added 11 | -------------- 12 | 13 | Bugs fixed 14 | ---------- 15 | 16 | Testing 17 | ------- 18 | -------------------------------------------------------------------------------- /utils/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sphinx-doc/sphinx/31e63d786aefcb54ba08fa6406a3579ec5ecdc8f/utils/__init__.py --------------------------------------------------------------------------------