@glaucidium

Существует ли нормальная документация по модулям питона(со сводкой содержимого и типизацией)(в стиле C#, Java)?

Или где можно найти примеры генерации такого стиля в сторонних доко-генераторах?

Содержания
Нормальные документации(как в java и C#) устроены иерархически. В модулях и классах сначала перечисляется список содержимого, сгруппированный по категориям(классы, исключения, …) с их кратким описанием. Таким образом, сразу можно понять, что из этого надо глянуть.

В python-же документация сразу выдана стеной текста. Содержания не всегда включают члены модуля. Группировок нет. Заголовки выделены слабо(проматывая текущий класс, легко не заметить что умотал в другой).
Пробовал pydoc — выдаёт примерно так-же.

Для сравнения. Документации по zip архивации.
Python
Пакет https://docs.python.org/3/library/gzip.html
Java
Пакет https://docs.oracle.com/javase/8/docs/api/java/uti...
Класс https://docs.oracle.com/javase/8/docs/api/java/uti...
C#
Пакет https://learn.microsoft.com/en-us/dotnet/api/syste...
Класс https://learn.microsoft.com/en-us/dotnet/api/syste...

Типизация
Mypy её уже описали. Лежит в ~/.local/pipx/venvs/mypy/lib/python3.11/site-packages/mypy/typeshed/stdlib/ надоело нырять туда просто ради ознакомления с классами.
  • Вопрос задан
  • 112 просмотров
Пригласить эксперта
Ответы на вопрос 1
Ничего лучше этого не нашёл
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы
03 мая 2024, в 21:24
400 руб./за проект
03 мая 2024, в 21:00
5000 руб./за проект
03 мая 2024, в 20:41
15000 руб./за проект