5
Me preguntaba si es posible usar POD (documentación simple) con Python? ¿Y cómo debería hacerlo?¿Es posible usar POD (documentación antigua simple) con Python?
A
Respuesta
1
No parece haber una forma directa de utilizar POD en línea en un archivo de Python. Sin embargo, los módulos de Python (incluida la biblioteca estándar de Python) están documentados usando reStructuredText. Esto generalmente se hace usando Sphinx, que produce la documentación de docstrings con formato ReStructuredText. Sphinx y el primero fueron diseñados específicamente para llenar un nicho similar a POD.
Cuestiones relacionadas
- 1. Documentación multilenguaje POD
- 2. ¿Es posible usar System.Transactions.TransactionScope con SqlBulkCopy?
- 3. Tipos imprsicativos vs. subtipificación antigua simple
- 4. ¿Es posible usar re2 desde Python?
- 5. ¿Es posible usar una biblioteca C con Python AppEngine?
- 6. ¿Es posible la documentación humana legible con Spock?
- 7. Cómo ejecutar la aplicación Java antigua simple en Android
- 8. ¿Es posible utilizar Python con php
- 9. ¿Cuál es la forma más simple de usar SSH Python?
- 10. ¿Es posible usar boost :: foreach con std :: map?
- 11. ¿es posible usar Eigen con c?
- 12. ¿Es posible usar Django con Qooxdoo framework?
- 13. ¿Es posible usar "bigint" condicionalmente con Perl?
- 14. ¿Es posible usar vim con el mouse
- 15. ¿Es posible usar "instaladores exe" con pip?
- 16. ¿Es posible usar cin con Qt?
- 17. ¿Es posible usar app_offline con Azure Websites?
- 18. ¿Es posible usar Ropemacs con TRAMP en Emacs?
- 19. ¿Es posible acelerar Python IO?
- 20. ¿Es posible generar XML simple usando Haml?
- 21. Ejemplo o documentación JQuery SlickGrid JSON simple
- 22. ¿Cómo es posible usar raw_input() en un gancho Python Git?
- 23. ¿Cómo crear POD y usar pod2usage en Perl?
- 24. Perl documentation (POD) navegadores?
- 25. ¿Es posible usar TTS en iOS
- 26. Atlassian Bamboo con Django y Python - ¿Es posible?
- 27. gdata-python-api + Análisis con auth simple
- 28. ¿Es posible descargar una APK antigua para mi aplicación desde Google Play?
- 29. ¿Es posible usar acumuladores de refuerzo con vectores?
- 30. subversion python vinculantes documentación?
¿Por qué lo necesita? Python tiene su propio formato de docstring que es interpretado por 'pydoc'. Si usa POD, los usuarios de su módulo necesitarían una herramienta para leerlo. ¿Estás seguro de que esto es lo que quieres? Si solo quieres documentar tu código, utiliza la cadena de documentos de python. – javex