Index

A

active (vdoc.models.plugins.base.Plugin property) (vdoc.models.plugins.footer.FooterPlugin property) (vdoc.models.plugins.FooterPlugin property) (vdoc.models.plugins.orama.OramaPlugin property) (vdoc.models.plugins.OramaPlugin property) (vdoc.models.plugins.theme.ThemePlugin property) (vdoc.models.plugins.ThemePlugin property)

add_more (vdoc.models.plugins.orama.OramaDictionary attribute) api_key (vdoc.models.plugins.orama.OramaPlugin attribute) (vdoc.models.plugins.OramaPlugin attribute) api_password (vdoc.settings.VDocSettings attribute) api_username (vdoc.settings.VDocSettings attribute)

B

bind_address (vdoc.settings.VDocSettings attribute)

bind_port (vdoc.settings.VDocSettings attribute)

C

category_id (vdoc.models.project.Project property) chat_button_label (vdoc.models.plugins.orama.OramaDictionary attribute) chat_placeholder (vdoc.models.plugins.orama.OramaDictionary attribute) check_for_default_credentials() (in module vdoc.cli.main)

clear_chat (vdoc.models.plugins.orama.OramaDictionary attribute) copyright (vdoc.models.plugins.footer.FooterPlugin attribute) (vdoc.models.plugins.FooterPlugin attribute) create_app() (in module vdoc.api)

D

dark (vdoc.models.plugins.theme.ThemePlugin attribute) (vdoc.models.plugins.ThemePlugin attribute) DEBUG (vdoc.cli.main.LogLevel attribute) dictionary (vdoc.models.plugins.orama.OramaPlugin attribute) (vdoc.models.plugins.OramaPlugin attribute)

disable_chat (vdoc.models.plugins.orama.OramaPlugin attribute) (vdoc.models.plugins.OramaPlugin attribute) disclaimer (vdoc.models.plugins.orama.OramaDictionary attribute) display_name (vdoc.models.project.Project property) docs_dir (vdoc.settings.VDocSettings attribute)

E

endpoint (vdoc.models.plugins.orama.OramaPlugin attribute) (vdoc.models.plugins.OramaPlugin attribute)

ERROR (vdoc.cli.main.LogLevel attribute) error_message (vdoc.models.plugins.orama.OramaDictionary attribute)

F

facet_property (vdoc.models.plugins.orama.OramaPlugin attribute) (vdoc.models.plugins.OramaPlugin attribute) FooterLink (class in vdoc.models.plugins.footer)

FooterLinkGroup (class in vdoc.models.plugins.footer) FooterPlugin (class in vdoc.models.plugins) (class in vdoc.models.plugins.footer)

G

get_app_name() (in module vdoc) get_app_version() (in module vdoc) get_app_version_route() (in module vdoc.api.routes.version)

get_project_version_impl() (in module vdoc.methods.api.projects) get_project_versions() (in module vdoc.api.routes.projects) get_router() (in module vdoc.api.routes.plugins) get_version_and_docs_path() (vdoc.models.project.Project class method)

H

href (vdoc.models.plugins.footer.FooterLink attribute)

I

icon (vdoc.models.plugins.footer.FooterLink attribute) id (vdoc.models.project_category.ProjectCategory attribute) INFO (vdoc.cli.main.LogLevel attribute) init_error_chat (vdoc.models.plugins.orama.OramaDictionary attribute)

init_error_search (vdoc.models.plugins.orama.OramaDictionary attribute) InvalidCredentials InvalidProjectName InvalidVersion

L

latest (vdoc.models.project.Project property) light (vdoc.models.plugins.theme.ThemePlugin attribute) (vdoc.models.plugins.ThemePlugin attribute) links (vdoc.models.plugins.footer.FooterLinkGroup attribute) (vdoc.models.plugins.footer.FooterPlugin attribute) (vdoc.models.plugins.FooterPlugin attribute) list() (vdoc.models.project.Project class method) list_project_categories() (in module vdoc.api.routes.project_categories)

list_project_categories_impl() (in module vdoc.methods.api.project_categories) list_project_versions() (in module vdoc.api.routes.projects) list_project_versions_impl() (in module vdoc.methods.api.projects) list_projects() (in module vdoc.api.routes.projects) list_projects_impl() (in module vdoc.methods.api.projects) load_plugins() (vdoc.models.plugins.base.Plugin class method) LogLevel (class in vdoc.cli.main) logo_url (vdoc.models.plugins.theme.ThemeSettings attribute) logo_url_small (vdoc.models.plugins.theme.ThemeSettings attribute)

M

model_config (vdoc.models.plugins.base.Plugin attribute) (vdoc.models.plugins.footer.FooterLink attribute) (vdoc.models.plugins.footer.FooterLinkGroup attribute) (vdoc.models.plugins.footer.FooterPlugin attribute) (vdoc.models.plugins.FooterPlugin attribute) (vdoc.models.plugins.orama.OramaDictionary attribute) (vdoc.models.plugins.orama.OramaPlugin attribute) (vdoc.models.plugins.OramaPlugin attribute) (vdoc.models.plugins.theme.ThemePlugin attribute) (vdoc.models.plugins.theme.ThemeSettings attribute) (vdoc.models.plugins.ThemePlugin attribute) (vdoc.models.project.Project attribute) (vdoc.models.project_category.ProjectCategory attribute) (vdoc.settings.VDocSettings attribute) model_post_init() (vdoc.models.plugins.base.Plugin method) (vdoc.models.plugins.footer.FooterPlugin method) (vdoc.models.plugins.FooterPlugin method) (vdoc.models.plugins.orama.OramaPlugin method) (vdoc.models.plugins.OramaPlugin method) (vdoc.models.plugins.theme.ThemePlugin method) (vdoc.models.plugins.ThemePlugin method) module vdoc vdoc.api vdoc.api.dependencies vdoc.api.dependencies.auth vdoc.api.lifespan vdoc.api.routes vdoc.api.routes.plugins vdoc.api.routes.project_categories vdoc.api.routes.projects vdoc.api.routes.version vdoc.cli vdoc.cli.main vdoc.cli.run vdoc.constants vdoc.exceptions vdoc.methods vdoc.methods.api vdoc.methods.api.project_categories vdoc.methods.api.projects vdoc.methods.cli vdoc.methods.cli.cli_run_method vdoc.models vdoc.models.plugins vdoc.models.plugins.base vdoc.models.plugins.footer vdoc.models.plugins.orama vdoc.models.plugins.theme vdoc.models.project vdoc.models.project_category vdoc.settings

N

name (vdoc.models.plugins.base.Plugin attribute) (vdoc.models.plugins.footer.FooterPlugin attribute) (vdoc.models.plugins.FooterPlugin attribute) (vdoc.models.plugins.orama.OramaPlugin attribute) (vdoc.models.plugins.OramaPlugin attribute) (vdoc.models.plugins.theme.ThemePlugin attribute) (vdoc.models.plugins.ThemePlugin attribute) (vdoc.models.project.Project attribute) (vdoc.models.project_category.ProjectCategory attribute)

no_results_found (vdoc.models.plugins.orama.OramaDictionary attribute) no_results_found_for (vdoc.models.plugins.orama.OramaDictionary attribute)

O

OramaDictionary (class in vdoc.models.plugins.orama)

OramaPlugin (class in vdoc.models.plugins) (class in vdoc.models.plugins.orama)

P

Plugin (class in vdoc.models.plugins.base) print_version() (in module vdoc.cli.main) Project (class in vdoc.models.project) project_categories (vdoc.settings.VDocSettings attribute) project_category_mapping (vdoc.settings.VDocSettings attribute)

project_display_name_mapping (vdoc.settings.VDocSettings attribute) ProjectCategory (class in vdoc.models.project_category) ProjectNotFound ProjectVersionAlreadyExists ProjectVersionNotFound

R

require_authentication() (in module vdoc.api.dependencies.auth) router (vdoc.models.plugins.base.Plugin property)

routes_loader_lifespan() (in module vdoc.api.lifespan) run_impl() (in module vdoc.methods.cli.cli_run_method)

S

search_button_label (vdoc.models.plugins.orama.OramaDictionary attribute) search_placeholder (vdoc.models.plugins.orama.OramaDictionary attribute)

see_all (vdoc.models.plugins.orama.OramaDictionary attribute) start_your_search (vdoc.models.plugins.orama.OramaDictionary attribute) suggestions (vdoc.models.plugins.orama.OramaDictionary attribute)

T

target (vdoc.models.plugins.footer.FooterLink attribute) ThemePlugin (class in vdoc.models.plugins) (class in vdoc.models.plugins.theme)

ThemeSettings (class in vdoc.models.plugins.theme) title (vdoc.models.plugins.footer.FooterLink attribute) (vdoc.models.plugins.footer.FooterLinkGroup attribute)

U

upload_project_version() (in module vdoc.api.routes.projects)

upload_project_version_impl() (in module vdoc.methods.api.projects) UploadedFileInvalid

V

validate_model() (vdoc.settings.VDocSettings method) validate_project_exists() (vdoc.models.project.Project class method) vdoc module vdoc.api module vdoc.api.dependencies module vdoc.api.dependencies.auth module vdoc.api.lifespan module vdoc.api.routes module vdoc.api.routes.plugins module vdoc.api.routes.project_categories module vdoc.api.routes.projects module vdoc.api.routes.version module vdoc.cli module vdoc.cli.main module vdoc.cli.run module vdoc.constants module vdoc.exceptions module

vdoc.methods module vdoc.methods.api module vdoc.methods.api.project_categories module vdoc.methods.api.projects module vdoc.methods.cli module vdoc.methods.cli.cli_run_method module vdoc.models module vdoc.models.plugins module vdoc.models.plugins.base module vdoc.models.plugins.footer module vdoc.models.plugins.orama module vdoc.models.plugins.theme module vdoc.models.project module vdoc.models.project_category module vdoc.settings module VDocException VDocSettings (class in vdoc.settings) versions (vdoc.models.project.Project property)

W

WARNING (vdoc.cli.main.LogLevel attribute)