Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support canonical name of python objects #7463

Merged
merged 1 commit into from May 4, 2020
Merged

Support canonical name of python objects #7463

merged 1 commit into from May 4, 2020

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Apr 12, 2020

Feature or Bugfix

  • Feature

Purpose

  • We can give some names to object in python. But current implementation only supports to describe a public name. But a runtime object only knows the name where the object is defined. So supporting canonical name for the object is important for autodoc.
  • This allows to describe additional name as a canonical name.
  • refs: Put qualname in the objects.inv #4826, python bases in packages #4944

@tk0miya tk0miya added this to the 3.1.0 milestone Apr 17, 2020
@tk0miya tk0miya mentioned this pull request Apr 17, 2020
Closed
@tk0miya tk0miya changed the title [WIP] Support canonical name of python objects Support canonical name of python objects Apr 17, 2020
@tk0miya tk0miya mentioned this pull request Apr 26, 2020
Closed
@tk0miya tk0miya force-pushed the 4944_canonical_name branch 2 times, most recently from 3391f4b to 02daed3 Compare May 3, 2020 13:42
shimizukawa
shimizukawa approved these changes May 3, 2020
View reviewed changes
Copy link
Member

@shimizukawa shimizukawa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@tk0miya tk0miya modified the milestones: 3.1.0, 4.0.0 May 3, 2020
@tk0miya tk0miya changed the base branch from 3.x to master May 3, 2020 14:10
@tk0miya tk0miya force-pushed the 4944_canonical_name branch 2 times, most recently from 5d9e50b to e7e62ef Compare May 3, 2020 16:57
@tk0miya tk0miya merged commit 4ad466c into sphinx-doc:master May 4, 2020
@tk0miya tk0miya deleted the 4944_canonical_name branch May 4, 2020 06:05
@oscarbenjamin oscarbenjamin mentioned this pull request Jun 14, 2020
Merged
@altendky altendky mentioned this pull request Aug 14, 2020
Draft
4 tasks
@tk0miya tk0miya mentioned this pull request Nov 15, 2020
Closed
@tk0miya tk0miya mentioned this pull request Jan 18, 2021
Closed
@ChaiByte ChaiByte mentioned this pull request Apr 8, 2021
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@shimizukawa shimizukawa shimizukawa approved these changes

Assignees
No one assigned
Labels
extensions:autodoc type:bug
Projects
None yet
Milestone
4.0.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@tk0miya @shimizukawa