sphinx-doc/sphinx

Partial functions are not documented when the original function comes from a different module

Open

#8.550 aberto em 17 de dez. de 2020

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Python (1.985 forks)batch import
extensions:autodochelp wantedtype:bug

Métricas do repositório

Stars
 (5.625 stars)
Métricas de merge de PR
 (Mesclagem média 10d 11h) (11 fundiu PRs em 30d)

Description

Describe the bug When using autodoc, partial functions do not appear in the HTML output if the original function (used to create the new partial function) comes from a different module.

To Reproduce Steps to reproduce the behavior:

$ git clone https://github.com/scganterh/sphinx_bug_partial_functions.git
$ cd sphinx_bug_partial_functions
$ pip install sphinx
$ make html
$ # open html/b.html and see that no documentation for the `b` function is generated.

Expected behavior I expect to see the documentation for b.b generated the same way as the documentation for b.d.

Your project https://github.com/scganterh/sphinx_bug_partial_functions

Screenshots image You can see there is no entry for b.b.

Environment info

  • OS: Linux
  • Python version: 3.6.2
  • Sphinx version: 3.3.1
  • Sphinx extensions: sphinx.ext.autodoc
  • Extra tools: Browser

Guia do colaborador

Direção de pesquisa
Investigue como o autodoc resolve funções parciais, especificamente por que falha quando a função original está em um módulo diferente. Verifique a lógica na extensão autodoc que lida com objetos parciais e veja se há um problema de resolução de módulo.
Pilha de tecnologia
python
Domain
documentationbackend
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60