Virtual Fieldwork Companion Backend API Documentation Modules Classes Names

search in docstrings

Search bar offers the following options:

Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
Wildcards. The below example searches for documents with words beginning with “foo”: foo*
Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.
Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Package vf-companion-backend

Modules

src
Modules
- api
  
  Modules
  
  git
  
  Modules
  
  branch
  
  commit
  
  history
  
  note
  
  repo
  
  log
  
  Classes
  
  Log
  
  Variables
  
  user_args
  
  package
  
  Classes
  
  Export
  
  ExportGitNotes
  
  Import
  
  MarkdownNotes
  
  Variables
  
  user_args
  
  unreal
  
  Classes
  
  UnrealInfo
  
  UnrealInit
  
  UnrealReturn
- app
  
  Functions
  
  create_app
  
  create_git_api
  
  create_pkg_api
  
  create_unreal_api
- util
  
  Modules
  
  git2provConverter
  
  Functions
  
  clone
  
  convert
  
  convert_repository_to_prov
  
  get_prov_document
  
  getPrefixes
  
  iterate_repository
  
  iterate_repository_head
  
  repo_structure_to_prov
  
  update_prov_document
  
  util_funcs
  
  Functions
  
  disconnect_all
  
  generate_unreal_request
  
  print_git_notes
  
  util_types
  
  Classes
  
  LabBook
  
  UnrealMode
  
  Variables
  
  DEFAULT_REPO_NAME
  
  UNREAL_PIE
  
  UNREAL_STANDALONE
- install
- main
  
  Functions
  
  connect
  
  Variables
  
  app
  
  REPOSITORIES_DIR
  
  socketio
  
  STATIC_DIR
  
  TEMPLATE_DIR
  
  _options
  
  _parser
- _version
  
  Variables
  
  __version__
  
  __version_info__

`vf-companion-backend`

package documentation

Virtual Fieldwork Companion Backend

Package src Virtual Fieldwork Companion Backend

API Documentation for Virtual Fieldwork Companion Backend, generated by pydoctor 23.9.1 at 2024-03-11 16:10:02.