Questions marquées «python-sphinx»


6
L'autodoc Sphinx n'est pas assez automatique
J'essaie d'utiliser Sphinx pour documenter un projet de plus de 5000 lignes en Python. Il a environ 7 modules de base. Pour autant que je sache, pour utiliser autodoc, je dois écrire un code comme celui-ci pour chaque fichier de mon projet: .. automodule:: mods.set.tests :members: :show-inheritance: C'est beaucoup trop …



7
échin de la construction de sphinx - autodoc ne peut pas importer / trouver le module
J'essaie de démarrer avec Sphinx et je semble avoir des problèmes incessants. Commander: docs/sphinx-quickstart Je réponds à toutes les questions et tout fonctionne bien. Commander: docs/ls Tout semble normal. Résultat:build Makefile source Commander: sphinx-build -d build/doctrees source build/html Cela semble fonctionner. J'ai pu ouvrir le fichier index.html et voir un …



6
Est-ce que sphinx peut créer un lien vers des documents qui ne se trouvent pas dans des répertoires sous le document racine?
J'utilise Sphinx pour documenter un projet non Python. Je souhaite distribuer des ./docdossiers dans chaque sous-module, contenant des submodule_name.rstfichiers pour documenter ce module. Je veux ensuite aspirer ces fichiers dans la hiérarchie principale pour créer une spécification pour l'ensemble de la conception. C'est à dire: Project docs spec project_spec.rst conf.py …


1
La construction de Read-the-docs échoue avec "impossible d'importer le nom 'PackageFinder' de 'pip._internal.index'"
La génération de documents Sphinx sur read-the-docs échoue avec l'erreur suivante (journal complet ci-dessous): 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) Ai-je fait quelque chose de mal ou est-ce un bug dans read-the-docs? Une version locale de documents Sphinx fonctionne correctement. Journal des erreurs complet sur read-the-docs: Read the …

2
Pourquoi le fichier html converti à partir du premier fichier contenant un point d'interrogation ne peut pas s'afficher sur le navigateur quand cliquer sur le catalogue?
Veuillez télécharger le fichier simple.7zet l'installer dans votre sphinx pour reproduire les problèmes que j'ai décrits ici, afin de le reproduire, vous pouvez exécuter: make clean make html téléchargez et installez dans votre sphinx pour reproduire les problèmes Il y a deux articles dans sample/source, le contenu est le même, …
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.