Edit on GitHub

src.scripts.create_docs 

 1import os
 2import sys
 3from pathlib import Path
 4
 5import pdoc
 6from pdoc.render import configure
 7
 8# Добавляем путь к директории проекта в системный путь
 9sys.path.insert(1, os.path.dirname(sys.path[0]))
10
11from core.path import PATH
12
13
14def create_docs():
15    """Создает документацию для проекта с использованием pdoc.
16
17    Эта функция настраивает параметры генерации документации и вызывает
18    pdoc для создания документации из исходного кода проекта.
19
20    Настройки документации включают формат документации, логотип, ссылку на логотип
21    и URL для редактирования исходного кода на GitHub.
22
23    Returns:
24        None
25    """
26    path = Path(PATH)
27    configure(
28        docformat="google",
29        logo="/static/Logo2_no_back_2.png",
30        logo_link="/vpn",
31        edit_url_map={
32            "src": "https://github.com/daniil-mazurov/vpn_dan_bot/blob/DEV/src/"
33        },
34    )
35    pdoc.pdoc(path / "src", output_directory=path / "docs")
36
37
38if __name__ == "__main__":
39    create_docs()
def create_docs(): 
15def create_docs():
16    """Создает документацию для проекта с использованием pdoc.
17
18    Эта функция настраивает параметры генерации документации и вызывает
19    pdoc для создания документации из исходного кода проекта.
20
21    Настройки документации включают формат документации, логотип, ссылку на логотип
22    и URL для редактирования исходного кода на GitHub.
23
24    Returns:
25        None
26    """
27    path = Path(PATH)
28    configure(
29        docformat="google",
30        logo="/static/Logo2_no_back_2.png",
31        logo_link="/vpn",
32        edit_url_map={
33            "src": "https://github.com/daniil-mazurov/vpn_dan_bot/blob/DEV/src/"
34        },
35    )
36    pdoc.pdoc(path / "src", output_directory=path / "docs")

Создает документацию для проекта с использованием pdoc.

Эта функция настраивает параметры генерации документации и вызывает pdoc для создания документации из исходного кода проекта.

Настройки документации включают формат документации, логотип, ссылку на логотип и URL для редактирования исходного кода на GitHub.

Returns:

None