[mkdocs] Add github action that tests the build of the example pages
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 18.8k
- Forks
- 2.8k
- Merge médio
- 16h 26min
- PRs com merge (30d)
- 21
Descrição
Right now we build the examples from jupyter notebooks here
https://github.com/plotly/plotly.py/blob/main/.circleci/config.yml#L356-L388
If any notebook outputs an error the build fails and the docs won't publish
We need to implement something similar for the new docs so we don't end up showing failures on published pages
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 lendo as etapas de build do notebook em .circleci/config.yml nas linhas 356-388 e compare-as com o novo build da página de exemplo do MkDocs. Defina o check do GitHub Actions para que erros na saída do notebook façam o build falhar antes da publicação da documentação; considera-se concluído quando o workflow detecta essas falhas.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- github-actions, jupyter-notebook, python
- Domínio
- build-system, ci-cd, documentation
- Tipo de issue
- Funcionalidade
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 42/100