Index

A

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)

check_for_default_credentials() (in module vdoc.cli.main)

D

DEBUG (vdoc.cli.main.LogLevel attribute)

display_name (vdoc.models.project.Project property) docs_dir (vdoc.settings.VDocSettings attribute)

E

ERROR (vdoc.cli.main.LogLevel attribute)

G

get_app_name() (in module vdoc) get_app_version() (in module vdoc) get_logo_url() (in module vdoc.api.routes.settings)

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

I

id (vdoc.models.project_category.ProjectCategory attribute) INFO (vdoc.cli.main.LogLevel attribute)

InvalidCredentials InvalidProjectName InvalidVersion

L

latest (vdoc.models.project.Project property) 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) LogLevel (class in vdoc.cli.main) logo_dark_url (vdoc.settings.VDocSettings attribute) logo_light_url (vdoc.settings.VDocSettings attribute)

M

model_config (vdoc.models.project.Project attribute) (vdoc.models.project_category.ProjectCategory attribute) (vdoc.settings.VDocSettings attribute) module vdoc vdoc.api vdoc.api.dependencies vdoc.api.dependencies.auth vdoc.api.routes vdoc.api.routes.project_categories vdoc.api.routes.projects vdoc.api.routes.settings 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.project vdoc.models.project_category vdoc.settings

N

name (vdoc.models.project.Project attribute) (vdoc.models.project_category.ProjectCategory attribute)

P

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)

run_impl() (in module vdoc.methods.cli.cli_run_method)

S

serve_sphinx_objects_inventory() (in module vdoc.api)

serve_ui_and_assets() (in module vdoc.api)

U

unicorn_exception_handler() (in module vdoc.api) 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.routes module vdoc.api.routes.project_categories module vdoc.api.routes.projects module vdoc.api.routes.settings 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.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)