Skip to content
Logo Logovdoc 0.5.0 documentation
⌘ K
Logo Logovdoc 0.5.0 documentation
  • vdoc package
    • vdoc.api package
    • vdoc.cli package
    • vdoc.exceptions package
    • vdoc.methods package
    • vdoc.models package
    • vdoc.settings package
  • Open Source Software License Compliance Information

vdoc package

Subpackages

  • vdoc.api package
    • Subpackages
      • vdoc.api.dependencies package
        • Submodules
        • vdoc.api.dependencies.auth module
        • Module contents
      • vdoc.api.routes package
        • Submodules
        • vdoc.api.routes.projects module
        • Module contents
    • Module contents
      • serve_sphinx_objects_inventory()
      • serve_ui_and_assets()
      • unicorn_exception_handler()
  • vdoc.cli package
    • Submodules
    • vdoc.cli.main module
      • LogLevel
      • check_for_default_credentials()
      • print_version()
    • vdoc.cli.run module
    • Module contents
  • vdoc.exceptions package
    • Module contents
      • InvalidCredentials
      • InvalidProjectName
      • InvalidVersion
      • ProjectNotFound
      • ProjectVersionAlreadyExists
      • ProjectVersionNotFound
      • UploadedFileInvalid
      • VDocException
  • vdoc.methods package
    • Subpackages
      • vdoc.methods.api package
        • Submodules
        • vdoc.methods.api.projects module
        • Module contents
      • vdoc.methods.cli package
        • Submodules
        • vdoc.methods.cli.cli_run_method module
        • Module contents
    • Module contents
  • vdoc.models package
    • Submodules
    • vdoc.models.project module
      • Project
    • Module contents
  • vdoc.settings package
    • Module contents
      • VDocSettings

Submodules

vdoc.constants module

Contains all constant values.

Module contents

Multi version documentation hosting.

vdoc.get_app_name()

Returns the human-readable and prettified name of the application.

Return type:

str

Returns:

The name of the application.

vdoc.get_app_version()

Returns the version of the application.

Return type:

str

Returns:

The version of the application.

vdoc
vdoc.api package

On this page

  • Subpackages
  • Submodules
  • vdoc.constants module
  • Module contents
    • get_app_name()
    • get_app_version()

© voraus robotik GmbH