Skript generate_module_docs

Dokumentace skriptu docs/generate_module_docs.py.

Přehled modulu

Skript pro generování Sphinx dokumentace pro všechny Django moduly v webclient/ a jejich uložení do docs/source/04_django_aplikace/04_02_moduly/

Skript extrahuje docstringy z modulů a generuje podrobnou reStructuredText dokumentaci pro každý adresář modulu.

Použití:

  • autodoc: Používá direktivy Sphinx autodoc

  • explicit: Zapisuje docstringy přímo do RST –module MODULE Konkrétní modul ke zpracování (např. ‚adb‘, ‚core‘) Pokud není zadáno, zpracuje všechny moduly

Třídy

class DockerImageScanner

Prohledává soubory projektu a sbírá tagy Docker image.

Prochází všechny soubory docker-compose*.yml v kořenovém adresáři projektu a soubor Dockerfile-DB. Výsledkem je slovník mapující základní název image (bez tagu) na jeho plný tag.

Parametry:

project_root (Path) – Kořenový adresář projektu.

Metody:

__init__()

Inicializuje scanner s kořenovým adresářem projektu.

Parametry:

project_root (Path) – Kořenový adresář projektu.

collect_versions()

Shromáždí verze image ze souborů docker-compose a Dockerfile-DB.

Prochází nejprve compose soubory, poté Dockerfile-DB. Pro každý základní název image je uložen první nalezený plný tag (produkční soubory mají přednost díky pořadí vrácenému metodou _ordered_compose_files()).

Vrací:

Slovník {základní název image: plný tag}.

Typ návratové hodnoty:

Dict[str, str]

_compose_images()

Extrahuje plné tagy image ze souborů docker-compose.

Přeskočí proměnné (${...}) a testovací image (docker.io/library/test_*).

Vrací:

Seznam plných tagů image (např. redis:8.4.0).

Typ návratové hodnoty:

List[str]

_dockerfile_images()

Extrahuje image z direktiv FROM v souboru Dockerfile-DB.

Pokud soubor Dockerfile-DB neexistuje, vrátí prázdný seznam.

Vrací:

Seznam plných tagů image z direktiv FROM.

Typ návratové hodnoty:

List[str]

_ordered_compose_files()

Vrátí seznam souborů docker-compose seřazených podle priority.

Produkční soubory (docker-compose.yml, docker-compose-proxy.yml) jsou řazeny jako první, aby jejich verze image měly přednost při volání collect_versions().

Vrací:

Seřazený seznam cest k souborům docker-compose.

Typ návratové hodnoty:

List[Path]

_base_image()

Vrátí základní název image bez tagu.

Parametry:

full_tag (str) – Plný tag image (např. redis:8.4.0).

Vrací:

Název image bez tagu (např. redis).

Typ návratové hodnoty:

str

class JsLibrary

Datová třída reprezentující jednu Node.js knihovnu.

Parametry:

  • name (str) – Název balíčku (např. bootstrap).

  • version (str) – Verze balíčku (např. 5.3.8).

  • license (str) – Identifikátor licence (např. MIT).

  • homepage (str) – URL domovské stránky nebo repozitáře knihovny.

Funkce

vprint()

Vypíše zprávu pouze ve verbose režimu.

Parametry:

  • args – Poziční argumenty předané do print().

  • kwargs – Klíčové argumenty předané do print().

check_content_changed(content, output_file)

Zkontroluje, zda se obsah liší od existujícího souboru.

Parametry:

  • content – Nový obsah k porovnání.

  • output_file – Cesta k existujícímu souboru.

Vrací:

True, pokud se obsah změnil nebo soubor neexistuje

extract_url_patterns(urls_file)

Extrahujte vzory URL ze souboru urls.py.

Parametry:

urls_file – Cesta k souboru urls.py.

Vrací:

Každý url_pattern je slovník s klíči: pattern, view, `name`

parse_path_call(node)

Analyzuje volání path() nebo re_path() a extrahuje informace o vzoru URL.

Parametry:

node – uzel AST představující volání path().

Vrací:

`dict: {'pattern': str, 'view': str, 'name': str} or None`

generate_url_routing_rst()

Vygeneruje dokumentaci k směrování URL pro všechny moduly.

Vytvoří docs/source/04_django_aplikace/04_01_core/url_routing.rst s tabulkami všech vzorů URL z urls.py každého modulu.

Vrací:

True, pokud úspěšné, jinak false

extract_signals(signals_file)

Extrahuje přijímače signálu ze souboru signals.py.

Parametry:

signals_file – Cesta k souboru signals.py.

Vrací:

Seznam slovníků informací o signálech s klíči: function, signal_type, sender, `weak`

parse_receiver_decorator(decorator, function_name)

Analyzuje dekorátor @receiver() pro extrakci informací o signálu.

Parametry:

  • decorator – AST Volací uzel představující @receiver()

  • function_name – Název dekorované funkce

Vrací:

`dict: {'function': str, 'signal_type': str, 'sender': str, 'weak': str} or None`

generate_signals_rst()

Vygeneruje dokumentaci signálů pro všechny moduly.

Vytvoří docs/source/04_django_aplikace/04_01_core/signals.rst s tabulkami všech přijímačů signálů z každého modulu signals.py

Vrací:

True v případě úspěchu, False v opačném případě.

extract_permissions(models_file)

Extrahuje možnosti akcí z třídy Permissions v models.py.

Parametry:

models_file – Cesta k souboru models.py.

Vrací:

Seznam názvů akcí (např. adb_smazat, `vb_smazat`)

generate_permissions_rst()

Vygeneruje dokumentaci oprávnění.

Aktualizuje docs/source/04_django_aplikace/04_01_core/permissions.rst připojením seznamu všech definovaných akcí z Permissions.actionChoices za nadpis „Uživatelské akce řízené pomocí oprávnění”.

Vrací:

True, pokud úspěšné, jinak False.

clean_comment_value(value)

Odstraní obalové uvozovky/závorky z hodnoty komentáře.

Parametry:

value – Parametr value pracuje se s atributy strip.

Vrací:

Hodnota vrácená funkcí podle aktuální logiky implementace.

parse_comment_values(comment_text)

Vrátí mapované hodnoty získané z inline komentáře XSD.

Parametry:

comment_text – Číselná hodnota comment_text použitá při výpočtu nebo transformaci.

Vrací:

Hodnota vrácená funkcí podle aktuální logiky implementace.

get_following_comment(parent, element)

Najde první uzel komentáře bezprostředně za daným elementem.

Parametry:

  • parent – Parametr parent se předává do volání list().

  • element – Parametr element ovlivňuje větvení podmínek.

Vrací:

Hodnota vrácená funkcí podle aktuální logiky implementace.

collect_choice_element_names(choice_element)

Shromáždí názvy všech uzlů xs:element uvnitř bloku choice.

Parametry:

choice_element – Parametr choice_element slouží jako vstup pro logiku funkce collect_choice_element_names.

Vrací:

Hodnota vrácená funkcí podle aktuální logiky implementace.

format_choice_note(names)

Naformátuje poznámku popisující možnosti uvnitř elementu choice.

Parametry:

names – Kolekce names zpracovávaná touto funkcí.

Vrací:

Hodnota vrácená funkcí podle aktuální logiky implementace.

extract_elements_from_parent(parent, choice_context)

Rekurzivně extrahuje definice elementů a zaznamená kontext choice, pokud existuje.

Parametry:

  • parent – Parametr parent se předává do volání get_following_comment().

  • choice_context – Kolekce choice_context zpracovávaná touto funkcí.

Vrací:

Hodnota vrácená funkcí podle aktuální logiky implementace.

extract_elements_from_complex_type(complex_type)

Extrahuje řádky elementů z definice complexType.

Parametry:

complex_type – Parametr complex_type slouží jako vstup pro logiku funkce extract_elements_from_complex_type.

Vrací:

Hodnota vrácená funkcí podle aktuální logiky implementace.

extract_model_mappings(schema_root)

Načte mapování z volby elementu amcr do řádků Model -> ComplexType.

Parametry:

schema_root – Parametr schema_root pracuje se s atributy find.

Vrací:

Hodnota vrácená funkcí podle aktuální logiky implementace.

extract_xsd_version(schema_root)

Extrahuje atribut verze z kořenového prvku schématu XSD.

Parametry:

schema_root – Kořenový prvek schématu XSD.

Vrací:

Verze (např. „2.2“) nebo „neznámá“, pokud nebyla nalezena

extract_django_command_info(command_file)

Extrahuje informace o dokumentaci ze souboru příkazů pro správu Django.

Parametry:

command_file – Cesta k příkazovému souboru.

Vrací:

`dict: {'name': str, 'help': str, 'docstring': str, 'arguments': list}`

extract_command_arguments(add_arguments_node)

Extrahuje definice argumentů z metody add_arguments.

Parametry:

add_arguments_node – AST uzel metody add_arguments.

Vrací:

Seznam slovníků s informacemi o argumentech s klíči: name, type, help, `default`

generate_management_commands_rst()

Vygeneruje dokumentaci k příkazům pro správu.

Vytvoří docs/source/04_django_aplikace/04_01_core/management_commands.rst s dokumentací ke všem příkazům pro správu Django v core/management/commands.

Vrací:

True, pokud úspěšné, jinak False.

generate_export_structure_rst()

Vygeneruje docs/source/05_integrace/export_structure.rst ze souboru amcr.xsd.

Vrací:

Hodnota vrácená funkcí podle aktuální logiky implementace.

has_meaningful_code(source_file)

Zkontroluje, zda soubor Python obsahuje smysluplný kód (nejen komentáře).

Parametry:

source_file – Cesta k souboru.

Vrací:

rue, pokud soubor obsahuje smysluplný kód, False v opačném případě.

extract_docstrings(source_file)

Extrahuje docstrings z modulu Python pomocí AST parsování.

Parametry:

source_file – Cesta ke zdrojovému souboru.

Vrací:

tuple: (docstring modulu nebo None, třídy, funkce); třídy a funkce jsou seznamy slovníků.

_looks_like_sphinx_fieldlist(docstring)

Vrátí True, pokud text vypadá jako Sphinx info pole (:param:, :return: atd.).

_indent_docstring_lines(docstring, indent)

Přidá indent k neprázdným řádkům; prázdné řádky ponechá prázdné.

format_docstring_for_rst(docstring, indent)

Formátuje docstring pro výstup RST v režimu explicit.

Docstringy se Sphinx poli (:param:, :return:, …) se předají beze změny obsahu (jen odsazení). Google sekce (Args:, Returns:, …) se převedou na stejná Sphinx info pole.

Parametry:

  • docstring – Docstring, který se má formátovat

  • indent – Prefix odsazení pro každý řádek.

Vrací:

Seznam formátovaných řádků RST.

generate_rst_explicit(source_file, module_name, module_title, module_description)

Vygeneruje soubor RST s explicitním obsahem docstringu.

Parametry:

  • source_file – Cesta k zdrojovému souboru.

  • module_name – Plně kvalifikovaný název modulu.

  • module_title – Název souboru RST.

  • module_description – Popis modulu.

Vrací:

Vygenerovaný obsah RST.

generate_rst_autodoc(module_name, module_title, module_description)

Vygeneruje soubor RST pomocí direktiv Sphinx autodoc.

Parametry:

  • module_name – Plně kvalifikovaný název modulu.

  • module_title – Název souboru RST`.

  • module_description – HPopis modulu.

Vrací:

Vygenerovaný obsah RST.

get_module_title_and_description(module_dir_name, filename)

Předá příslušný název a popis souboru modulu.

Parametry:

  • module_dir_name – Název adresáře modulu (např. adb, core).

  • filename – Název souboru Python (např. models.py).

Vrací:

tuple: (title, description)

generate_rst_for_file(source_file, module_dir_name, output_dir, mode)

Vygeneruje dokumentaci RST pro jeden soubor Python.

Parametry:

  • source_file – Cesta ke zdrojovému souboru Python.

  • module_dir_name – Název adresáře modulu.

  • output_dir – Výstupní adresář pro soubory RST.

  • mode – Režim generování (autodoc nebo explicit).

Vrací:

True v případě úspěchu, False v opačném případě.

generate_index_rst(module_dir_name, generated_files, output_dir)

Vygeneruje soubor index.rst s toctree všech vygenerovaných modulů.

Parametry:

  • module_dir_name – Název adresáře modulu.

  • generated_files – Seznam vygenerovaných názvů souborů Python.

  • output_dir – Výstupní adresář.

Vrací:

True v případě úspěchu, False v opačném případě

process_module(module_dir_name, mode)

Zpracuje jeden adresář modulu.

Parametry:

  • module_dir_name – Název adresáře modulu.

  • mode – Režim generování (autodoc nebo explicit).

Vrací:

True, pokud byly vygenerovány nějaké soubory.

get_all_modules()

Získá všechny adresáře modulů Django z webového klienta.

Vrací:

Seznam názvů adresářů modulů.

generate_all_modules(mode, specific_module)

Vygeneruje soubory RST pro všechny moduly nebo konkrétní modul.

Parametry:

  • mode – Režim generování (autodoc nebo explicit).

  • specific_module – Konkrétní modul, který se má zpracovat, nebo None pro všechny.

Vrací:

True, pokud byla vygenerována nějaká dokumentace.

generate_rst_for_docs_script(source_file, output_dir, mode)

Vygeneruje dokumentaci RST pro jeden Python skript v adresáři docs/.

Parametry:

  • source_file – Cesta ke zdrojovému souboru Python v docs/.

  • output_dir – Výstupní adresář pro soubory RST.

  • mode – Režim generování (autodoc nebo explicit).

Vrací:

True v případě úspěchu, False v opačném případě.

generate_docs_scripts_index_rst(generated_files, output_dir)

Vygeneruje index.rst pro dokumentační skripty v docs/.

Parametry:

  • generated_files – Seznam vygenerovaných názvů souborů Python.

  • output_dir – Výstupní adresář.

Vrací:

True v případě úspěchu, False v opačném případě.

generate_docs_scripts_docs(mode)

Vygeneruje RST dokumentaci pro všechny *.py skripty v docs/.

Parametry:

mode – Režim generování (autodoc nebo explicit).

Vrací:

True, pokud byl vygenerován alespoň jeden soubor.

get_script_language(script_name)

Vrátí jazyk pro zvýraznění syntaxe podle přípony souboru.

Parametry:

script_name – Parametr script_name předává se do volání Path().

Vrací:

Vrací hodnotu typu str (str).

get_script_doc_name(script_name)

Vrátí bezpečný název RST souboru pro skript.

Parametry:

script_name – Parametr script_name předává se do volání sub(), vstupuje do návratové hodnoty.

Vrací:

Vrací hodnotu typu str (výsledek volání lower()).

generate_rst_for_project_script(source_file, output_dir)

Vygeneruje RST dokumentaci pro jeden soubor v adresáři scripts/.

Parametry:

  • source_file – Parametr source_file předává se do volání get_script_doc_name(), get_script_language(), pracuje se s atributy name.

  • output_dir – Parametr output_dir slouží jako vstup pro logiku funkce generate_rst_for_project_script.

Vrací:

Vrací hodnotu typu bool podle vyhodnocení podmínek.

generate_project_scripts_index_rst(toctree_entries, output_dir)

Vygeneruje index.rst pro skripty v adresáři scripts/.

Parametry:

  • toctree_entries – Parametr toctree_entries předává se do volání sorted().

  • output_dir – Parametr output_dir slouží jako vstup pro logiku funkce generate_project_scripts_index_rst.

Vrací:

Vrací hodnotu typu bool podle vyhodnocení podmínek.

generate_project_scripts_docs()

Vygeneruje RST dokumentaci pro soubory v scripts/.

Vrací:

Vrací hodnotu typu bool podle vyhodnocení podmínek.

build_docs()

Vytvoří HTML dokumentaci pomocí Sphinx.

Vrací:

True, pokud se sestavení podařilo, False v opačném případě.

_fetch_dockerhub_odkaz(image)

Načte zdrojovou URL pro Docker Hub image (best-effort, bez autentizace).

Parametry:

image (str) – Základní název image, např. grafana/grafana-enterprise.

Vrací:

Řetězec zdrojové URL, nebo prázdný řetězec při chybě nebo nepodporovaném registru.

Typ návratové hodnoty:

str

_parse_compose_versions(project_root)

Parsuje všechny soubory docker-compose*.yml a Dockerfile-DB v project_root a hledá direktivy image:. Vrátí slovník mapující základní název image na plný tag.

Priorita: docker-compose.yml / docker-compose-proxy.yml (produkce) jako první, poté ostatní soubory.

Parametry:

project_root (Path) – Kořenový adresář projektu.

Vrací:

Slovník {základní název image: plný tag}.

Typ návratové hodnoty:

Dict[str, str]

_check_missing_meta_images(versions, images_meta)

Vrátí seznam základních názvů image nalezených v docker-compose / Dockerfile-DB, které nejsou pokryty žádným záznamem v docker_images_meta.yaml.

Proměnné reference na image (${...}) v compose souborech jsou již filtrovány třídou DockerImageScanner, takže jsou kontrolovány pouze konkrétní názvy image.

Parametry:

  • versions (Dict[str, str]) – Slovník {základní název image: plný tag} z docker-compose souborů.

  • images_meta (List[Dict[str, str]]) – Seznam metadatových záznamů z docker_images_meta.yaml.

Vrací:

Seřazený seznam základních názvů image chybějících v metadatech.

Typ návratové hodnoty:

List[str]

_load_odkaz_cache()

Načte mezipaměť odkazů DockerHub ze souboru docker_images_odkaz_cache.yaml.

Pokud soubor neexistuje, vrátí prázdný slovník.

Vrací:

Slovník {název image: URL} s dříve uloženými odkazy.

Typ návratové hodnoty:

Dict[str, str]

_save_odkaz_cache(cache)

Uloží mezipaměť odkazů DockerHub do souboru docker_images_odkaz_cache.yaml.

Parametry:

cache (Dict[str, str]) – Slovník {název image: URL} k uložení.

Načte DockerHub odkazy pouze pro image, které ještě nejsou v mezipaměti, paralelně.

Parametry:

  • image_keys (List[str]) – Seznam základních názvů image, pro které se mají načíst odkazy.

  • cache (Dict[str, str]) – Existující mezipaměť odkazů {název image: URL}.

Vrací:

Aktualizovaná mezipaměť včetně nově načtených odkazů.

Typ návratové hodnoty:

Dict[str, str]

generate_docker_images_rst()

Vygeneruje dokumentaci Docker image.

Vrací:

True v případě úspěchu, False v opačném případě.

Typ návratové hodnoty:

bool

_build_section_header(title, description)

Vytvoří záhlaví sekce RST.

Parametry:

  • title (str) – Název sekce.

  • description (str) – Popis sekce.

Vrací:

Seznam řádků RST záhlaví sekce.

Typ návratové hodnoty:

List[str]

_build_image_block(entry, versions, hub_cache)

Sestaví RST blok pro jeden Docker image.

Parametry:

  • entry (Dict[str, str]) – Metadatový záznam image z docker_images_meta.yaml.

  • versions (Dict[str, str]) – Slovník {základní název image: plný tag} z docker-compose souborů.

  • hub_cache (Dict[str, str]) – Mezipaměť odkazů DockerHub {název image: URL}.

Vrací:

Seznam řádků RST bloku pro daný image.

Typ návratové hodnoty:

List[str]

_extract_version(full_tag)

Extrahuje verzi tagu z plného tagu Docker image.

Parametry:

full_tag (str) – Plný tag image (např. redis:8.4.0).

Vrací:

Verze tagu (např. 8.4.0), nebo latest pokud tag není přítomen.

Typ návratové hodnoty:

str

load_json(path)

Načte a vrátí obsah JSON souboru.

Parametry:

path (Path) – Cesta k JSON souboru.

Vrací:

Deserializovaný obsah JSON souboru.

Typ návratové hodnoty:

dict

normalize_repo_url(url)

Normalizuje URL repozitáře pro zobrazení v dokumentaci.

Odstraní prefix git+, převede git://host/… na https://host/… (prohlížeče git:// nepodporují spolehlivě) a ořízne příponu .git.

Parametry:

url (str) – Surová URL repozitáře (např. git+https://github.com/foo/bar.git).

Vrací:

Normalizovaná URL (např. https://github.com/foo/bar).

Typ návratové hodnoty:

str

npm_package_page_url(package_name)

Vrátí kanonickou URL stránky balíčku na https://www.npmjs.com/.

Používá se jako záložní odkaz, když v node_modules není k dispozici homepage ani repository (např. při běhu generátoru bez npm install). Scoped balíčky (@scope/name) se kódují s %2F místo lomítka v cestě.

Parametry:

package_name (str) – Název balíčku z package.json (např. leaflet nebo @types/node).

Vrací:

URL ve tvaru https://www.npmjs.com/package/....

Typ návratové hodnoty:

str

Z existujícího RST vytáhne mapu název balíčku → odkaz z generovaného bloku.

Parsuje řádky list-table mezi značkami .. BEGIN GENERATED NODEJS LIBRARIES a .. END GENERATED NODEJS LIBRARIES. Řádek záhlaví tabulky (Název knihovny) se přeskočí. Slouží k zachování odkazů při běhu bez node_modules (např. CI), aby se nepřepisovaly platné URL hodnotami z npm_package_page_url().

Očekává stejný čtyřřádkový tvar řádků tabulky jako build_rst_table(); ruční zalamování buněk může parsování rozhodit.

Parametry:

rst_content (str) – Obsah souboru javascript_knihovny.rst (nebo ekvivalent).

Vrací:

Slovník {název balíčku: URL} pro neprázdné odkazy.

Typ návratové hodnoty:

Dict[str, str]

load_dependencies(package_json)

Načte produkční závislosti ze slovníku package.json.

Parametry:

package_json (dict) – Deserializovaný obsah souboru package.json.

Vrací:

Slovník {název balíčku: verze} z pole dependencies.

Typ návratové hodnoty:

Dict[str, str]

load_lock_licenses(lock_file)

Načte licence balíčků ze souboru package-lock.json.

Prochází sekci packages lock souboru a extrahuje pole license pro každý záznam pod klíčem node_modules/<název>.

Parametry:

lock_file (Path) – Cesta k souboru package-lock.json.

Vrací:

Slovník {název balíčku: licence}.

Typ návratové hodnoty:

Dict[str, str]

read_node_module_metadata(project_root, name)

Načte licenci a URL domovské stránky balíčku z adresáře node_modules.

Pokud soubor package.json daného balíčku neexistuje, vrátí dvojici prázdných řetězců. Pole license může být řetězec nebo objekt s klíčem type (starší formát npm). URL repozitáře je normalizována pomocí normalize_repo_url().

Parametry:

  • project_root (Path) – Kořenový adresář projektu obsahující node_modules.

  • name (str) – Název balíčku (např. bootstrap).

Vrací:

Dvojice (licence, homepage_url).

Typ návratové hodnoty:

tuple[str, str]

collect_libraries(project_root, dependencies, lock_licenses, preserved_links)

Sestaví seznam Node.js knihoven obohacený o licence a URL.

Pro každou závislost z dependencies nejprve hledá licenci v lock_licenses (ze souboru package-lock.json), a pokud ji nenajde, čte ji přímo ze souboru package.json v node_modules. Homepage se čte z node_modules; chybí-li, použije se dříve uložený odkaz z preserved_links (poslední generovaný blok v RST — stabilizuje CI bez npm ci), jinak URL stránky balíčku na npm (npm_package_page_url()). Nový balíček bez uloženého odkazu tedy dostane vždy npm URL. Záznamy jsou seřazeny abecedně podle názvu balíčku.

Parametry:

  • project_root (Path) – Kořenový adresář projektu obsahující node_modules.

  • dependencies (Dict[str, str]) – Slovník {název balíčku: verze} z package.json.

  • lock_licenses (Dict[str, str]) – Slovník {název balíčku: licence} z package-lock.json.

  • preserved_links (Optional[Dict[str, str]]) – Volitelně odkazy z existujícího generovaného bloku RST.

Vrací:

Seřazený seznam objektů JsLibrary.

Typ návratové hodnoty:

List[JsLibrary]

build_rst_table(rows)

Sestaví RST blok s tabulkou Node.js knihoven.

Vygeneruje sekci dokumentace ve formátu list-table ohraničenou značkami BEGIN_MARKER a END_MARKER, která obsahuje sloupce Název knihovny, Verze, Licence a Odkaz.

Parametry:

rows (List[JsLibrary]) – Seznam záznamů Node.js knihoven k zobrazení v tabulce.

Vrací:

Řetězec s RST obsahem tabulky včetně ohraničujících značek.

Typ návratové hodnoty:

str

insert_generated_block(content, block)

Vloží nebo nahradí generovaný blok mezi značkami v RST obsahu.

Parametry:

  • content – Původní text souboru (např. .rst).

  • block – Nový generovaný úsek včetně značek začátku a konce.

Vrací:

Obsah po vložení bloku, jinak block předřazený před content.

generate_js_libraries_rst()

Vygeneruje tabulku Node.js JavaScript knihoven pro javascript_knihovny.rst.

Licences berou z package-lock.json; odkazy nejprve z node_modules, při jejich absenci z existujícího generovaného bloku v souboru, jinak z npm_package_page_url(). Pro aktualizaci odkazů z metadat balíčků (homepage, repository) je potřeba mít nainstalované závislosti (npm ci).

Vrací:

True v případě úspěchu, False v opačném případě.

Typ návratové hodnoty:

bool

main()

Hlavní funkce pro spuštění generátoru dokumentace.