Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • A AutoIntent
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 10
    • Issues 10
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 2
    • Merge requests 2
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • DeepPavlov
  • AutoIntent
  • Merge requests
  • !49

Docs/structured api ref

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Roman Zlobin requested to merge docs/structured-api-ref into dev Nov 24, 2024
  • Overview 2
  • Commits 8
  • Pipelines 0
  • Changes 112

Created by: voorhs

Цель данного PR: теперь красивое API Reference

Что изменилось:

  • Chatsky.regenerate_api_doc -> AutoAPI. Теперь используется расширение сфинкса под названием AutoAPI. Это совершенно другой способ создания референса, нежели используется в чатском. Причина такого перехода: наша библиотека намного сложнее устроена, у нее много уровней вложения пакетов. Утилиты, которые я ранее позаимствовал из чатского, тяжело справлялись с таким.
  • Расширение AutoAPI позволяет исключать из документации объекты, которые имеют _ в начале. Поэтому я переименовал кучу файлов и вспомогательных объектов, которые не хочу видеть в документации. Мне кажется это не так плохо, потому что такой же подход используется в документации sklearn
  • Из-за того что теперь куча модулей стали приватными, импорты из них мне кажется можно считать нежелательными. Я пока что исправил простейшие случаи импортов из приватных модулей, но еще парочка осталось

P.S Теперь все вот так красивенько и структурированно image

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: docs/structured-api-ref