Add the sphinx-codeautolink extension to the doc build process?
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 77.2k
- Forks
- 36k
- Métricas de merge de PRs
- Métricas de PR pendentes
Descrição
I am proposing to include the https://github.com/felix-hilden/sphinx-codeautolink Sphinx extension into the documentation build process. This extension makes parseable Python code examples clickable so that it's easy to jump to the reference documentation of an object.
Related thread: https://discuss.python.org/t/add-the-sphinx-codeautolink-extension-to-doc-build-process/80814/11
A pull request to add the extension is upcoming.
Linked PRs
- gh-134896
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece revisando a configuração de build da documentação e o projeto sphinx-codeautolink vinculado na issue; em seguida, leia a thread relacionada no discuss.python.org e a PR gh-134896. Considera-se concluído quando a extensão estiver incluída no build da documentação e os exemplos de Python analisáveis se tornarem links clicáveis para a documentação de referência.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Funcionalidade
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 25/100