Ho un PDF che ha una spiegazione approfondita per un esempio nella documentazione di Sphinx per un pacchetto che ho. C'è un modo per includere facilmente il PDF nel mio progetto (e copiarlo quando creo i documenti)? Ho provato a collegarlo ad: doc: ma questo non è stato copiato.Qual è il modo migliore per includere un PDF nella mia documentazione Sphinx?
10
A
risposta
13
Utilizzare il ruolo di testo :download: per inserire un file aggiuntivo arbitrario. Quindi nel tuo caso potresti fare qualcosa del genere:
For an in-depth explanation, please see :download:`A Detailed Example <some_extra_file.pdf>`.
Problemi correlati
- 1. Sphinx per documentazione codice php
- 2. mostra * solo * docstring nella documentazione di Sphinx
- 3. Hosting Private Sphinx Documentazione
- 4. Qual è il modo migliore per costruire un NSCompoundPredicate complesso?
- 5. Documentazione Sphinx Public API
- 6. Qual è il modo migliore per visualizzare un file PDF in Delphi 2009
- 7. Qual è il modo migliore per tracciare l'esecuzione di JavaScript?
- 8. Documentazione Sphinx all'interno di un Flask che esegue un'applicazione web
- 9. Qual è il modo migliore per chiudere un ramo Mercurial?
- 10. Qual è il modo migliore per ridimensionare un oggetto BitmapData?
- 11. Qual è il modo migliore per generare una documentazione dell'API REST?
- 12. Qual è il modo migliore per documentare il codice f #?
- 13. Qual è il modo migliore per includere un numero di build per il monitoraggio di Google Analytics delle app native?
- 14. È possibile generare un singolo file .pot dalla documentazione Sphinx?
- 15. Qual è il modo migliore di includere un file JS dal codice JS?
- 16. Qual è il modo migliore per bloccare intenzionalmente la mia applicazione Windows?
- 17. Il modo migliore per includere il codice di debug?
- 18. Qual è il modo migliore per rilevare il colore bianco?
- 19. Qual è il modo migliore per testare un'app per rails?
- 20. Qual è il modo migliore per convertire String in ByteString
- 21. Qual è il modo migliore per attivare le stampe Python?
- 22. Qual è il modo migliore per riutilizzare il parser Lua?
- 23. Qual è il modo migliore per affermare l'uguaglianza di numpy.array?
- 24. Qual è il modo migliore per gestire più azioni?
- 25. Qual è il modo migliore per imparare Django 1.5?
- 26. Qual è il modo migliore per scrivere commenti in C?
- 27. Qual è il modo migliore per convertire enum in stringa?
- 28. Qual è il modo migliore per estendere le funzionalità?
- 29. Qual è il modo migliore per imparare Erlang?
- 30. Qual è il modo migliore per distribuire un'app Pylons?