Index

Symbols

--external teachbooks-clean command line option --process-only teachbooks-build command line option --publish teachbooks-build command line option --release teachbooks-build command line option

--verbose teachbooks-serve command line option teachbooks-serve-path command line option --version teachbooks command line option -v teachbooks-serve command line option teachbooks-serve-path command line option

A

add_header_admonitions() (in module teachbooks.external_content.headers) add_md_admonition() (in module teachbooks.external_content.headers) add_nb_admonition() (in module teachbooks.external_content.headers) add_origin_notes() (in module teachbooks.external_content.headers)

add_rst_admonition() (in module teachbooks.external_content.headers) APALabelStyle (class in teachbooks.plugins.pybtex.labels.apa) APAStyle (class in teachbooks.plugins.pybtex.formatting.apa) AuthorYearRoundReferenceStyle (class in teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa)

B

bib_union() (in module teachbooks.external_content.bib) BibEntry (class in teachbooks.external_content.bib) bracket_author (teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa.AuthorYearRoundReferenceStyle attribute) bracket_label (teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa.AuthorYearRoundReferenceStyle attribute)

bracket_parenthetical (teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa.AuthorYearRoundReferenceStyle attribute) bracket_style() (in module teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa) bracket_textual (teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa.AuthorYearRoundReferenceStyle attribute) bracket_year (teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa.AuthorYearRoundReferenceStyle attribute)

C

check_plugins() (in module teachbooks.external_content.config) check_requirements() (in module teachbooks.external_content.requirements) check_server() (in module teachbooks.cli.main) chmod_git_files() (in module teachbooks.external_content.process_toc) citekey (teachbooks.external_content.bib.BibEntry attribute)

clean_yaml() (in module teachbooks.release) content (teachbooks.external_content.bib.BibEntry attribute) copy_ext() (in module teachbooks.release) count_brackets() (in module teachbooks.external_content.bib) create_repository_dir_name() (in module teachbooks.external_content.git)

D

default_label_style (teachbooks.plugins.pybtex.formatting.apa.APAStyle attribute)

default_name_style (teachbooks.plugins.pybtex.formatting.apa.APAStyle attribute) default_sorting_style (teachbooks.plugins.pybtex.formatting.apa.APAStyle attribute)

E

echo_info() (in module teachbooks.cli.main)

entrytype (teachbooks.external_content.bib.BibEntry attribute) external_to_local() (in module teachbooks.external_content.process_toc)

F

find() (in module teachbooks.external_content.bib) find_bibfile() (in module teachbooks.external_content.bib) find_config() (in module teachbooks.external_content.config) find_license() (in module teachbooks.external_content.licenses) find_plugins() (in module teachbooks.external_content.config) FirstLastStyle (class in teachbooks.plugins.pybtex.names.firstlast) format() (teachbooks.plugins.pybtex.names.firstlast.FirstLastStyle method) format_author_or_editor_and_date() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) format_author_or_editor_names() (teachbooks.plugins.pybtex.labels.apa.APALabelStyle method) format_btitle() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) format_doi() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method)

format_editor() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) format_eprint() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) format_header() (in module teachbooks.external_content.headers) format_label() (teachbooks.plugins.pybtex.labels.apa.APALabelStyle method) format_labels() (teachbooks.plugins.pybtex.labels.apa.APALabelStyle method) format_names() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) format_pages() (in module teachbooks.plugins.pybtex.formatting.apa) format_pubmed() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) format_title() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) format_url() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) format_volume() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) format_web_refs() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method)

G

get_article_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_book_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_booklet_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_branch_tag_name() (in module teachbooks.external_content.git) get_content_path() (in module teachbooks.external_content.process_toc) get_inbook_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_incollection_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_inproceedings_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_manual_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method)

get_mastersthesis_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_misc_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_myst_extensions() (in module teachbooks.external_content.config) get_phdthesis_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_proceedings_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_repo_url() (in module teachbooks.external_content.git) get_sphinx_plugins() (in module teachbooks.external_content.config) get_teachbooks_config() (in module teachbooks.external_content.config) get_techreport_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method) get_unpublished_template() (teachbooks.plugins.pybtex.formatting.apa.APAStyle method)

I

is_running (teachbooks.serve.Server property)

L

load() (teachbooks.serve.Server class method)

load_yaml_file() (in module teachbooks.external_content.utils)

M

make_release() (in module teachbooks.release) merge_bibs() (in module teachbooks.external_content.bib) modify_field() (in module teachbooks.external_content.utils) module teachbooks teachbooks.cli teachbooks.cli.main teachbooks.external_content teachbooks.external_content.bib teachbooks.external_content.config teachbooks.external_content.git teachbooks.external_content.headers teachbooks.external_content.licenses teachbooks.external_content.process_toc teachbooks.external_content.requirements teachbooks.external_content.utils teachbooks.plugins teachbooks.plugins.pybtex teachbooks.plugins.pybtex.formatting teachbooks.plugins.pybtex.formatting.apa teachbooks.plugins.pybtex.labels teachbooks.plugins.pybtex.labels.apa teachbooks.plugins.pybtex.names teachbooks.plugins.pybtex.names.firstlast teachbooks.plugins.sphinxcontrib_bibtex teachbooks.plugins.sphinxcontrib_bibtex.style teachbooks.plugins.sphinxcontrib_bibtex.style.referencing teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa teachbooks.release teachbooks.serve

N

name (teachbooks.plugins.pybtex.formatting.apa.APAStyle attribute)

P

PATH_SOURCE teachbooks-build command line option teachbooks-clean command line option teachbooks-serve-path command line option

prepend() (in module teachbooks.external_content.headers) process_external_toc_entries() (in module teachbooks.external_content.process_toc)

R

read_bibfile() (in module teachbooks.external_content.bib)

read_cloned_repos() (in module teachbooks.external_content.process_toc) read_requirements() (in module teachbooks.external_content.requirements)

S

serve_path() (in module teachbooks.cli.main) Server (class in teachbooks.serve) ServerError

start() (teachbooks.serve.Server method) statefile (teachbooks.serve.Server attribute) stdout_summary() (in module teachbooks.cli.main) stop() (teachbooks.serve.Server method)

T

teachbooks module teachbooks command line option --version teachbooks-build command line option --process-only --publish --release PATH_SOURCE teachbooks-clean command line option --external PATH_SOURCE teachbooks-serve command line option --verbose -v teachbooks-serve-path command line option --verbose -v PATH_SOURCE teachbooks.cli module teachbooks.cli.main module teachbooks.external_content module teachbooks.external_content.bib module teachbooks.external_content.config module teachbooks.external_content.git module teachbooks.external_content.headers module teachbooks.external_content.licenses module

teachbooks.external_content.process_toc module teachbooks.external_content.requirements module teachbooks.external_content.utils module teachbooks.plugins module teachbooks.plugins.pybtex module teachbooks.plugins.pybtex.formatting module teachbooks.plugins.pybtex.formatting.apa module teachbooks.plugins.pybtex.labels module teachbooks.plugins.pybtex.labels.apa module teachbooks.plugins.pybtex.names module teachbooks.plugins.pybtex.names.firstlast module teachbooks.plugins.sphinxcontrib_bibtex module teachbooks.plugins.sphinxcontrib_bibtex.style module teachbooks.plugins.sphinxcontrib_bibtex.style.referencing module teachbooks.plugins.sphinxcontrib_bibtex.style.referencing.author_year_apa module teachbooks.release module teachbooks.serve module

U

url (teachbooks.serve.Server property)

V

validate_licenses() (in module teachbooks.external_content.licenses)

W

write_bibfile() (in module teachbooks.external_content.bib)

write_toc_yaml() (in module teachbooks.external_content.process_toc)