5
Mi chiedevo se è possibile utilizzare POD (plain old documentation) con Python? E come dovrei farlo?È possibile utilizzare POD (plain old documentation) con Python?
A
risposta
1
Non sembra essere un modo direttamente supportato per utilizzare POD in linea in un file Python. Tuttavia, i moduli Python (inclusa la libreria standard Python) sono documentati usando reStructuredText. Di solito questo viene fatto usando Sphinx, che produce la documentazione da docstrings formattati in reStructuredText. Sfinge e prima sono state specificamente progettate per riempire una nicchia simile al POD.
Problemi correlati
- 1. Plain old Ruby posizione in Rails
- 2. È possibile utilizzare la clausola IN in plain sql Slick?
- 3. Python Packaging Documentation
- 4. Qual è la differenza tra POJO (Plain Old Java Object) e DTO (Data Transfer Object)?
- 5. È possibile utilizzare tox con installazioni Python basate su conda?
- 6. È possibile utilizzare Django con py2exe?
- 7. È possibile utilizzare connessioni persistenti con System.Net.Http.HttpClient?
- 8. È possibile utilizzare la clausola IN in plain sql Slick per numeri interi?
- 9. Metodo 'documentation'
- 10. cocoapods: utilizzare la versione pod specifica
- 11. È possibile utilizzare Kubernetes come Docker Compose?
- 12. È possibile utilizzare Cruise Control con VB6?
- 13. È possibile utilizzare unique_lock con un recursive_mutex?
- 14. Non è possibile utilizzare UISearchController con UICollectionView?
- 15. È possibile utilizzare un MemoryStream con FileStreamResult?
- 16. È possibile utilizzare UDP con socket.io?
- 17. È possibile utilizzare System.Transactions.TransactionScope con SqlBulkCopy?
- 18. è possibile utilizzare Eigen con c?
- 19. È possibile utilizzare Console2 con Powershell?
- 20. È possibile utilizzare vim con il mouse
- 21. è possibile utilizzare batman.js con express?
- 22. Non è possibile utilizzare "Analizza" con swift?
- 23. è possibile utilizzare CASE con EXEC
- 24. È possibile utilizzare Harmony (ES6) con JSXTransformer.js?
- 25. È possibile utilizzare una counter_cache con has_many?
- 26. È possibile utilizzare Vagrant con intelliJ?
- 27. È possibile utilizzare "exe installers" con pip?
- 28. Git- archive old commits
- 29. Come è possibile utilizzare raw_input() in un hook Git Python?
- 30. Refactoring Ember-Cli per utilizzare i pod
Perché ne hai bisogno. Python ha il proprio formato docstring che viene interpretato da 'pydoc'. Se si utilizza POD, gli utenti del modulo necessitano di uno strumento per leggerlo. Sei sicuro che questo è quello che vuoi? Se vuoi solo documentare il tuo codice, usa la docstring di python. – javex