Je déteste la TVD mais j'adore le sphinx. Existe-t-il un moyen pour le sphinx de lire le démarque au lieu de
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:...
Comment insérer une référence croisée dans une page reST / Sphinx vers un sous-en-tête ou une ancre dans une autre page du même ensemble de
Sphinx ne génère pas de documentation pour __init __ (self) par défaut. J'ai essayé ce qui suit: .. automodule:: mymodule :members: et ..autoclass:: MyClass :members: Dans conf.py, définir ce qui suit n'ajoute que la docstring __init __ (self) à la classe docstring ( la documentation de l'autodoc...
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...
J'utilise sphinx et le plugin autodoc pour générer la documentation API pour mes modules Python. Bien que je puisse voir comment documenter joliment des paramètres spécifiques, je ne trouve pas d'exemple sur la façon de documenter un **kwargsparamètre. Quelqu'un a-t-il un bon exemple d'une manière...
J'essaie de créer une liste correctement imbriquée en utilisant le code suivant (en suivant les documents Sphinx et docutils ): 1. X a. U b. V c. W 2. Y 3. Z Je m'attends à ce que cela entraîne deux OLs mais j'obtiens à la place la sortie suivante: <ol class="arabic simple">...
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...
Je souhaite ajouter un lien vers une méthode de ma classe à partir de la docstring d'une autre méthode de la même classe. Je veux que le lien fonctionne dans sphinx et de préférence aussi dans Spyder et d'autres IDE Python. J'ai essayé plusieurs options et n'en ai trouvé qu'une qui fonctionne,...
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'
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...