DHI / DHI/python-package-development
Consider recommending great-docs for documentation module
- Linguagem predominante
- Jupyter Notebook
- Estrelas
- 8
- Forks
- 1
- Merge médio
- 4min
- PRs com merge (30d)
- 1
Descrição
The documentation module currently covers MkDocs. [great-docs](https://github.com/posit-dev/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.txt` files
## Links
- [Documentation](https://posit-dev.github.io/great-docs/)
- [GitHub](https://github.com/posit-dev/great-docs)
- [PyPI](https://pypi.org/project/great-docs/) (requires Python 3.11+)
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
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.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Pouca atividade
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 35/100