teachbooks package

Subpackages

• teachbooks.cli package
  • Submodules
    • teachbooks.cli.main module
      • check_server()
      • echo_info()
      • serve_path()
      • stdout_summary()
  • Module contents
• teachbooks.external_content package
  • Submodules
    • teachbooks.external_content.bib module
      • BibEntry
      • bib_union()
      • count_brackets()
      • find()
      • find_bibfile()
      • merge_bibs()
      • read_bibfile()
      • write_bibfile()
    • teachbooks.external_content.config module
      • check_plugins()
      • find_config()
      • find_plugins()
      • get_myst_extensions()
      • get_sphinx_plugins()
      • get_teachbooks_config()
    • teachbooks.external_content.git module
      • create_repository_dir_name()
      • get_branch_tag_name()
      • get_repo_url()
    • teachbooks.external_content.headers module
      • add_header_admonitions()
      • add_md_admonition()
      • add_nb_admonition()
      • add_origin_notes()
      • add_rst_admonition()
      • format_header()
      • prepend()
    • teachbooks.external_content.licenses module
      • find_license()
      • validate_licenses()
    • teachbooks.external_content.process_toc module
      • chmod_git_files()
      • external_to_local()
      • get_content_path()
      • process_external_toc_entries()
      • read_cloned_repos()
      • write_toc_yaml()
    • teachbooks.external_content.requirements module
      • check_requirements()
      • read_requirements()
    • teachbooks.external_content.utils module
      • load_yaml_file()
      • modify_field()
  • Module contents
• teachbooks.plugins package
  • Subpackages
    • teachbooks.plugins.pybtex package
      • Subpackages
      • Module contents
    • teachbooks.plugins.sphinxcontrib_bibtex package
      • Subpackages
      • Module contents
  • Module contents

Submodules

• teachbooks.release module
  • clean_yaml()
  • copy_ext()
  • make_release()
• teachbooks.serve module
  • Server
    • Server.is_running
    • Server.load()
    • Server.start()
    • Server.statefile
    • Server.stop()
    • Server.url
  • ServerError

Module contents