Domande taggate «python-sphinx»

Sphinx è uno strumento che semplifica la creazione di una documentazione intelligente e bella. Sphinx è particolarmente adatto per la documentazione di Python, ma è uno strumento generico che può essere utilizzato per documentare qualsiasi cosa.

6
Sphinx autodoc non è abbastanza automatico
Sto cercando di usare Sphinx per documentare un progetto di oltre 5.000 righe in Python. Ha circa 7 moduli di base. Per quanto ne so, per usare l'autodoc ho bisogno di scrivere codice come questo per ogni file nel mio progetto: .. automodule:: mods.set.tests :members: :show-inheritance: Questo è troppo noioso …
7
sphinx-build fallisce - autodoc non può importare / trovare il modulo
Sto cercando di iniziare con Sphinx e sembra che abbia problemi implacabili. Comando: docs/sphinx-quickstart Rispondo a tutte le domande e tutto funziona bene. Comando: docs/ls Sembra tutto normale. Risultato:build Makefile source Comando: sphinx-build -d build/doctrees source build/html Sembra funzionare. Sono stato in grado di aprire il file index.html e vedere …
6
Sphinx può collegarsi a documenti che non si trovano nelle directory sotto il documento radice?
Sto usando Sphinx per documentare un progetto non Python. Voglio distribuire ./doccartelle in ogni sottomodulo, contenenti submodule_name.rstfile per documentare quel modulo. Quindi voglio risucchiare quei file nella gerarchia principale per creare una specifica per l'intero progetto. Cioè: Project docs spec project_spec.rst conf.py modules module1 docs module1.rst src module2 docs module2.rst …
3
Collegamento al metodo di classe in docstring python
Voglio aggiungere un collegamento a un metodo nella mia classe dall'interno della docstring di un altro metodo della stessa classe. Voglio che il collegamento funzioni in sphinx e preferenzialmente anche in Spyder e altri IDE di Python. Ho provato diverse opzioni e ne ho trovata solo una che funziona, ma …
1
La build di lettura dei documenti non riesce con "impossibile importare il nome" PackageFinder "da" pip._internal.index ""
La generazione di documenti Sphinx su read-the-docs non riesce con il seguente errore (registro completo di seguito): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) Ho fatto qualcosa di sbagliato o si tratta di un bug nella lettura dei documenti? Una build locale di documenti Sphinx funziona bene. Registro degli …
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.