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

Close #5603: autodoc: Allow to refer to a python object using canonical name #9026

Merged
merged 1 commit into from Mar 27, 2021
Merged

Close #5603: autodoc: Allow to refer to a python object using canonical name #9026

merged 1 commit into from Mar 27, 2021

Commits on Mar 27, 2021

  1. Close sphinx-doc#5603: autodoc: Allow to refer to a python object usi… 

    …ng canonical name

This generates `:canonical:` option for `:py:class:` directive if the
target class is imported from other module.  It allows users to refer it
using both the new name (imported name) and the original name (canonical
name).

It helps a library that implements some class in private module (like
`_io.StringIO`), and publish it as public module (like `io.StringIO`).
    @tk0miya
    tk0miya committed Mar 27, 2021
    Configuration menu
    Copy the full SHA
    acf66bc View commit details
    Browse the repository at this point in the history