Consider recommending great-docs for documentation module
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Documentação
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Pouca atividade
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Comece localizando a seção do módulo de documentação que atualmente aborda MkDocs e, em seguida, leia a documentação e o repositório vinculados do great-docs. Compare o requisito de Python 3.11+ e o fluxo de trabalho baseado em Quarto com a configuração do curso. Considera-se concluído quando a avaliação tiver uma conclusão documentada sobre se great-docs deve ser recomendado ou adicionado.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
The documentation module currently covers MkDocs. great-docs from Posit is a new Python documentation site generator worth evaluating as an alternative or addition.
Why it's interesting for this course
- Built on Quarto — same toolchain the course already uses for slides
- Zero-config API reference — auto-discovers public API from docstrings (NumPy, Google, Sphinx formats)
- Minimal setup —
great-docs init/build/preview, no templates or manual page authoring needed - Modern defaults — dark mode, responsive, sidebar search, GitHub integration
- AI-ready — generates
llms.txtfiles
Links
- Documentation
- GitHub
- PyPI (requires Python 3.11+)
- Linguagem predominante
- Jupyter Notebook
- Estrelas
- 8
- Forks
- 1
- Merge médio
- 4min
- PRs com merge (30d)
- 1
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
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.
Mais de DHI/python-package-development
-
Dificuldade 2/5 1-2 dias Facilidade para iniciantes 88/100
-
Dificuldade 2/5 1-2 dias Facilidade para iniciantes 72/100
DHI/python-package-development#37 · 1 comentário ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 48/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 48/100
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 48/100
Todas as issues de DHI/python-package-development
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
agilepathway/label-checker#640 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
BasedHardware/omi#15662 · 1 comentário ·
-
documentation help wanted
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 90/100
-
Docs are out of date: README structure tree, "Make It Yours" pointer, CONTRIBUTING test notes Abertadocumentation good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
amponce/archive-movie-browser#167 ·
-
user-reported
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
Kong/developer.konghq.com#7316 ·