apache/dolphinscheduler

[Feature][python] Add sphinx ext to get part of code from example

Open

#7.963 aberto em 12 de jan. de 2022

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Java (4.324 forks)batch import
Pyschedulerdocumentfeaturehelp wanted

Métricas do repositório

Stars
 (11.659 stars)
Métricas de merge de PR
 (Mesclagem média 2d 21h) (22 fundiu PRs em 30d)

Description

Search before asking

  • I had searched in the issues and found no similar feature requirement.

Description

To avoid duplicate code of the document, we should create a sphinx extension and quote code from the document. About extension for sphinx you could find in https://www.sphinx-doc.org/en/master/development/index.html.

Use case

No response

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Guia do colaborador

Direção de pesquisa
Crie uma nova extensão Sphinx (por exemplo, dolphin code include.py) no diretório docs/source/ ext/. Implemente uma diretiva que lê um arquivo de origem e inclui um trecho entre marcadores. Atualize docs/source/conf.py para carregar a extensão. Consulte o guia de desenvolvimento de extensões Sphinx em https://www.sphinx doc.org/en/master/development/index.html. Teste com a documentação existente para garantir a citação correta.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Funcionalidade
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.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
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.
65