Démarrer avec Sphinx
Guides Utilisateurs
sphinx.ext.autodoc – Inclure la documentation des chaînes docstringssphinx.ext.autosectionlabel – Autoriser les références automatiques aux sections par leurs titressphinx.ext.autosummary – Generate autodoc summariessphinx.ext.coverage – Collecte les statistiques de couverture de docsphinx.ext.doctest – Test snippets in the documentationsphinx.ext.duration – Mesurer les durées de traitement du Sphinxsphinx.ext.githubpages – Publie les documents HTML sur GitHub Pagessphinx.ext.graphviz – Ajouter des graphiques Graphvizsphinx.ext.ifconfig – Inclure du contenu basé sur la configurationsphinx.ext.ext.imgconverter – Un convertisseur d’image de référence utilisant Imagemagicksphinx.ext.inheritance_diagram – Inclure les diagrammes d’héritagesphinx.ext.linkcode – Ajouter des liens externes au code sourcesphinx.ext.napoleon – Support for NumPy and Google style docstringssphinx.ext.ext.todo – Prise en charge des éléments todosphinx.ext.viewcode – Add links to highlighted source codeCommunauté
Références
sphinx.ext.autodoc – Inclure la documentation des chaînes docstringssphinx.ext.autosectionlabel – Autoriser les références automatiques aux sections par leurs titressphinx.ext.autosummary – Generate autodoc summariessphinx.ext.coverage – Collecte les statistiques de couverture de docsphinx.ext.doctest – Test snippets in the documentationsphinx.ext.duration – Mesurer les durées de traitement du Sphinxsphinx.ext.githubpages – Publie les documents HTML sur GitHub Pagessphinx.ext.graphviz – Ajouter des graphiques Graphvizsphinx.ext.ifconfig – Inclure du contenu basé sur la configurationsphinx.ext.ext.imgconverter – Un convertisseur d’image de référence utilisant Imagemagicksphinx.ext.inheritance_diagram – Inclure les diagrammes d’héritagesphinx.ext.linkcode – Ajouter des liens externes au code sourcesphinx.ext.napoleon – Support for NumPy and Google style docstringssphinx.ext.ext.todo – Prise en charge des éléments todosphinx.ext.viewcode – Add links to highlighted source codesphinx.ext.githubpages – Publie les documents HTML sur GitHub Pages¶Added in version 1.4.
Modifié dans la version 2.0: Supporte le fichier CNAME
Cette extension crée un fichier .nojekyll dans le répertoire HTML généré pour publier sur GitHub Pages.
Cela crée également un fichier CNAME pour les domaines personnalisés lorsque html_baseurl est configurée.