Contenu de la documentation Sphinx

Démarrer avec Sphinx

• Démarrer avec Sphinx
  • Configurer les sources
  • Définir la structure
  • Ajouter du contenu
  • Générer la documentation
  • Documenter des objets
    • enumerate()
  • Configuration de base
  • Autodoc
  • Intersphinx
  • Pour aller plus loin
• Installer Sphinx
  • Résumé
  • Linux
    • Debian/Ubuntu
    • RHEL, CentOS
    • Autres distributions
  • macOS
    • Homebrew
    • MacPorts
    • Anaconda
  • Windows
    • Chocolatey
    • Autres méthodes
  • Installation depuis PyPI
    • Environnements virtuels
  • Docker
  • Installation depuis les sources
• Tutoriel : votre premier projet Sphinx
  • Démarrer avec Sphinx
    • Configurer votre projet et votre environnement de développement
    • Créer la structure de la documentation
  • Générer votre projet avec Sphinx
    • Générer votre documentation au format HTML
    • Générer votre documentation dans d’autres formats
  • Personnaliser votre projet Sphinx
    • Activer une extension intégrée
    • Utiliser un thème HTML tiers
  • Documentation narrative dans Sphinx
    • Structurer votre documentation sur plusieurs pages
    • Ajouter des références croisées
  • Documentation de code dans Sphinx
    • Python
    • Other languages (C, C++, others)
  • Automatic documentation generation from code
    • Reusing signatures and docstrings with autodoc
    • Generating comprehensive API references
  • Appendix: Deploying a Sphinx project online
    • Sphinx-friendly deployment options
    • Embracing the « Docs as Code » philosophy
    • Publishing your documentation sources
    • Publishing your HTML documentation
  • Où aller ensuite

Guides Utilisateurs

• Utiliser Sphinx
  • reStructuredText
    • reStructuredText Primer
    • Roles
    • Directives
    • Listes de champs
    • MOVED: Domains
  • Markdown
    • Configuration
  • Cross-referencing syntax
    • Cross-referencing anything
    • Cross-referencing objects
    • Cross-referencing arbitrary locations
    • Cross-referencing documents
    • Referencing downloadable files
    • Cross-referencing figures by figure number
    • Cross-referencing other items of interest
  • Configuration
    • Informations sur le projet
    • Configuration générale
    • Options pour l’internationalisation
    • Options for Math
    • Options pour la sortie HTML
    • Options for Single HTML output
    • Options for HTML help output
    • Options for Apple Help output
    • Options pour la sortie epub
    • Options pour la sortie LaTeX
    • Options pour la sortie text
    • Options for manual page output
    • Options pour la sortie Texinfo
    • Options pour la sortie QtHelp
    • Options for the linkcheck builder
    • Options for the XML builder
    • Options for the C domain
    • Options for the C++ domain
    • Options for the Python domain
    • Options for the Javascript domain
    • Exemple de fichier de configuration
  • Builders
    • StandaloneHTMLBuilder
    • DirectoryHTMLBuilder
    • SingleFileHTMLBuilder
    • HTMLHelpBuilder
    • QtHelpBuilder
    • AppleHelpBuilder
    • DevhelpBuilder
    • Epub3Builder
    • LaTeXBuilder
    • TextBuilder
    • ManualPageBuilder
    • TexinfoBuilder
    • SerializingHTMLBuilder
    • PickleHTMLBuilder
    • JSONHTMLBuilder
    • MessageCatalogBuilder
    • ChangesBuilder
    • DummyBuilder
    • CheckExternalLinksBuilder
    • XMLBuilder
    • PseudoXMLBuilder
    • Détails du constructeur de la sérialisation
  • Domains
    • Basic Markup
    • Built-in domains
    • More domains
  • Extensions
    • Built-in extensions
    • Extensions tierces
  • HTML Theming
    • Builders
    • Themes
  • Internationalisation
    • Détails de l’internationalisation avec Sphinx
    • Traduire avec sphinx-intl
    • Utilisation du service Transifex pour la traduction en équipe
    • Utilisation du service Weblate pour la traduction en équipe
    • Contribution à la traduction de Sphinx
    • Translation progress and statistics
  • Sphinx Web Support
    • Web Support Quick Start
    • The WebSupport Class
    • Search Adapters
    • Storage Backends
• Writing Sphinx Extensions
  • Developing extensions overview
    • Make an extension depend on another extension
  • Tutoriels d’extension
    • Développement d’une extension « Hello world »
    • Developing a « TODO » extension
    • Developing a « recipe » extension
    • Developing autodoc extension for IntEnum
  • Configuring builders
    • Discover builders by entry point
  • Templating
    • Do I need to use Sphinx’s templates to produce HTML?
    • Jinja/Sphinx Templating Primer
    • Working with the builtin templates
  • HTML theme development
    • Creating themes
    • Distribute your theme as a Python package
    • Templating
• LaTeX customization
  • The latex_elements configuration setting
  • The sphinxsetup configuration setting
  • Additional CSS-like 'sphinxsetup' keys
  • LaTeX macros and environments
    • Macros
    • The \sphinxbox command
    • Environments
    • Miscellany
• Sphinx Extensions API
  • Important objects
  • Build Phases
  • Métadonnées de l’extension
  • APIs used for writing extensions
    • Application API
    • Project API
    • Build environment API
    • Builder API
    • Environment Collector API
    • Docutils markup API
    • Domain API
    • Parser API
    • Doctree node classes added by Sphinx
    • Logging API
    • i18n API
    • Utilities
    • Deprecated APIs

Communauté

• Obtenir de l’aide
• Contribuer à Sphinx
  • Contribuer à Sphinx
    • Get help
    • Rapport de Bug et demandes de fonstionnalités
    • Contribute code
    • Contribute documentation
    • Debugging tips
  • Sphinx’s release process
    • Versioning
    • Deprecating a feature
    • Deprecation policy
    • Python version support policy
    • Release procedures
  • Organization of the Sphinx project
    • Core developers
    • Other contributors
  • Code de conduite Sphynx
• FAQ Sphinx
  • Comment faire…
  • Utiliser Sphinx avec …
  • Sphinx vs. Docutils
  • Epub info
  • Texinfo info
    • Affichage des liens
    • Notes
• Auteurs de Sphinx
  • Mainteneurs
  • Contributeurs
  • Former maintainers

Références

• Outils en Ligne de Commande
  • Applications principales
    • sphinx-quickstart
    • sphinx-build
  • Autres applications
    • sphinx-apidoc
    • sphinx-autogen
• Configuration
  • Informations sur le projet
  • Configuration générale
  • Options pour l’internationalisation
  • Options for Math
  • Options pour la sortie HTML
  • Options for Single HTML output
  • Options for HTML help output
  • Options for Apple Help output
  • Options pour la sortie epub
  • Options pour la sortie LaTeX
  • Options pour la sortie text
  • Options for manual page output
  • Options pour la sortie Texinfo
  • Options pour la sortie QtHelp
  • Options for the linkcheck builder
  • Options for the XML builder
  • Options for the C domain
  • Options for the C++ domain
  • Options for the Python domain
  • Options for the Javascript domain
  • Exemple de fichier de configuration
• Extensions
  • Built-in extensions
    • sphinx.ext.autodoc – Inclure la documentation des chaînes docstrings
    • sphinx.ext.autosectionlabel – Autoriser les références automatiques aux sections par leurs titres
    • sphinx.ext.autosummary – Generate autodoc summaries
    • sphinx.ext.coverage – Collecte les statistiques de couverture de doc
    • sphinx.ext.doctest – Test snippets in the documentation
    • sphinx.ext.duration – Mesurer les durées de traitement du Sphinx
    • mod:`sphinx.ext.ext.extlinks” – Balisage pour raccourcir les liens externes
    • sphinx.ext.githubpages – Publie les documents HTML sur GitHub Pages
    • sphinx.ext.graphviz – Ajouter des graphiques Graphviz
    • sphinx.ext.ifconfig – Inclure du contenu basé sur la configuration
    • sphinx.ext.ext.imgconverter – Un convertisseur d’image de référence utilisant Imagemagick
    • sphinx.ext.inheritance_diagram – Inclure les diagrammes d’héritage
    • mod:sphinx.ext.ext.intersphinx – Lien vers la documentation d’autres projets
    • sphinx.ext.linkcode – Ajouter des liens externes au code source
    • Math support for HTML outputs in Sphinx
    • sphinx.ext.napoleon – Support for NumPy and Google style docstrings
    • sphinx.ext.ext.todo – Prise en charge des éléments todo
    • sphinx.ext.viewcode – Add links to highlighted source code
  • Extensions tierces
    • Où mettre vos propres extensions ?
• reStructuredText
  • reStructuredText Primer
    • Paragraphs
    • Inline markup
    • Lists and Quote-like blocks
    • Literal blocks
    • Doctest blocks
    • Tables
    • Hyperlinks
    • Sections
    • Listes de champs
    • Roles
    • Explicit Markup
    • Directives
    • Images
    • Notes de bas de page
    • Citations
    • Substitutions
    • Comments
    • HTML Metadata
    • Source encoding
    • Gotchas
  • Roles
    • Cross-referencing syntax
    • Inline code highlighting
    • Math
    • Other semantic markup
    • Substitutions
  • Directives
    • Table of contents
    • Paragraph-level markup
    • Showing code examples
    • Glossaire
    • Meta-information markup
    • Index-generating markup
    • Including content based on tags
    • Tables
    • Math
    • Grammar production displays
  • Listes de champs
    • File-wide metadata
    • Champs de métadonnées spéciaux
  • MOVED: Domains
    • MOVED: Basic Markup
    • MOVED: Python Domain
    • MOVED: C Domain
    • MOVED: C++ Domain
    • MOVED: Standard Domain
    • MOVED: JavaScript Domain
    • MOVED: reStructuredText Domain
    • MOVED: Math Domain
    • MOVED: More domains
• Glossaire
• Changelog
• Projets utilisant Sphinx
  • Documentation utilisant le thème alabaster
  • Documentation utilisant le thème classique
  • Documentation utilisant le thème sphinxdoc
  • Documentation utilisant le thème nature
  • Documentation utilisant un autre thème intégré
  • Documentation utilisant le thème sphinx_rtd_theme
  • Documentation utilisant le thème sphinx_bootstrap_theme
  • Documentation using pydata_sphinx_theme
  • Documentation utilisant un thème personnalisé ou intégrée dans un site Web
  • Pages d’accueil et autres sites non documentés
  • Livres produits avec Sphinx
  • Thèses réalisées avec Sphinx
  • Projets intégrant la fonctionnalité Sphinx