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

Fix #9630: autosummary: Failed to build summary table if primary_domain is not 'py' #9633

Merged
merged 2 commits into from Sep 17, 2021
Merged

Fix #9630: autosummary: Failed to build summary table if primary_domain is not 'py' #9633

merged 2 commits into from Sep 17, 2021

Commits on Sep 14, 2021

  1. Fix sphinx-doc#9630: autodoc: Failed to build xrefs if primary_domain… 

    … is not 'py'

Autodoc generates reST code that uses raw `:obj:` and `:class:` xrefs to
refer the classes and types.  But they're fragile because they assume
the primary_domain=='py'.

This adds `:py:` prefix to these xrefs to make them robust.
    @tk0miya
    tk0miya committed Sep 14, 2021
    Configuration menu
    Copy the full SHA
    ed227d7 View commit details
    Browse the repository at this point in the history

  2. Fix sphinx-doc#9630: autosummary: Failed to build summary table if pr… 

    …imary_domain is not 'py'

Autosummary generates reST code that uses raw `:obj:` xrefs to refer
the python objects in the summary table.  But they're fragile because
they assume the primary_domain=='py'.

This adds `:py:` prefix to these xrefs to make them robust.
    @tk0miya
    tk0miya committed Sep 14, 2021
    Configuration menu
    Copy the full SHA
    bc01207 View commit details
    Browse the repository at this point in the history