Index

Symbols

--badge command line option --branch command line option --chdir command line option --floating-badge command line option --force command line option --git-root command line option --help command line option --local-conf command line option --log command line option --main-branch command line option --no-prebuild command line option --no-quite command line option

--output command line option --prebuild command line option --quite command line option --reset-intersphinx command line option --sphinx-compability command line option --verbose command line option -b command line option -c command line option -log command line option -m command line option -o command line option -v command line option

_

_BranchTag (class in sphinx_versioned.versions) _build() (sphinx_versioned.build.VersionedDocs method) _generate_top_level_index() (sphinx_versioned.build.VersionedDocs method)

_handle_paths() (sphinx_versioned.build.VersionedDocs method) _parse() (sphinx_versioned.versions.BuiltVersions method) _parse_branches() (sphinx_versioned.versions.GitVersions method)

A

active_branch (sphinx_versioned.versions.GitVersions property)

B

branches (sphinx_versioned.versions._BranchTag property) build() (sphinx_versioned.build.VersionedDocs method)

builder_finished_tasks() (sphinx_versioned.sphinx_.EventHandlers class method) builder_inited() (sphinx_versioned.sphinx_.EventHandlers class method) BuiltVersions (class in sphinx_versioned.versions)

C

checkout() (sphinx_versioned.versions.GitVersions method) cleanup() (sphinx_versioned.lib.TempDir method) command line option --badge --branch --chdir --floating-badge --force --git-root --help --local-conf --log --main-branch --no-prebuild --no-quite --output --prebuild --quite --reset-intersphinx --sphinx-compability --verbose -b -c -log -m -o -v sv_project_url:

ConfigInject (class in sphinx_versioned.lib)

E

EventHandlers (class in sphinx_versioned.sphinx_)

G

GitVersions (class in sphinx_versioned.versions)

H

HandledError

html_page_context() (sphinx_versioned.sphinx_.EventHandlers class method)

M

main() (in module sphinx_versioned.__main__) module sphinx_versioned.__main__ sphinx_versioned.build sphinx_versioned.lib sphinx_versioned.sphinx_ sphinx_versioned.versions

mp_sphinx_compatibility() (in module sphinx_versioned.lib)

P

parse_branch_selection() (in module sphinx_versioned.lib)

prebuild() (sphinx_versioned.build.VersionedDocs method) PseudoBranch (class in sphinx_versioned.versions)

S

setup() (in module sphinx_versioned.sphinx_) show() (sphinx_versioned.lib.HandledError method) sphinx_versioned.__main__ module sphinx_versioned.build module sphinx_versioned.lib module

sphinx_versioned.sphinx_ module sphinx_versioned.versions module sv_project_url: command line option

T

tags (sphinx_versioned.versions._BranchTag property)

TempDir (class in sphinx_versioned.lib)

V

VersionedDocs (class in sphinx_versioned.build)