Générer de la documentation avec Sphinx

ImmenseDiopside3731 avatar
ImmenseDiopside3731
·
·
Download

Start Quiz

Study Flashcards

18 Questions

Quel est le nom du programme à utiliser pour générer la documentation en format HTML ?

make html

Où doit-on enregistrer les nouveaux fichiers pour ajouter des pages à la documentation?

index.rst

Quel est l'interpréteur de commandes utilisé sur Linux qui est également connu sous le nom de Bourne-Again SHell?

Bash

Quelle commande permet d'entrer dans un répertoire nommé 'documents' dans un terminal?

cd documents

Quelle touche est utilisée pour l'auto-complétion des commandes dans un terminal?

Tab

Quel est l'élément situé en bas à droite de la composition d'un Shell selon le texte?

Commande en cours d'écriture.

Que signifie la dette technique dans le développement logiciel?

L'écriture du code sans suivre les bonnes pratiques.

Quelle commande est utilisée pour supprimer un dossier dans un environnement de ligne de commande?

rmdir projet

Quelle commande est utilisée pour lancer les tests dans un environnement Python?

pytest.exe tests.py

Comment lister les fichiers du dossier courant dans un environnement de ligne de commande?

ls

Quelle commande est utilisée pour créer un dossier dans un environnement de ligne de commande?

md new_folder

Quelle commande est utilisée pour démarrer la création d'une documentation Sphinx?

sphinx-quickstart.exe

Quelle est la méthode recommandée pour documenter le code Python ?

Utiliser des commentaires spéciaux appelés docstrings

Que faut-il inclure dans un docstring pour documenter une fonction ?

Une description générale, les paramètres et la valeur de retour

Quelle est la syntaxe correcte pour définir un docstring en Python ?

''' Ceci est un docstring '''

Que devez-vous documenter dans un fichier Python ?

Une description générale du fichier et de son contenu

Quelle est la meilleure pratique pour documenter une classe en Python ?

Inclure un docstring pour la classe et chaque méthode

Que signifie l'acronyme 'pdoc' en relation avec la documentation Python ?

Un outil pour générer automatiquement de la documentation à partir de docstrings

Ce quiz aborde les étapes pour compiler la documentation avec Sphinx, notamment en générant la documentation en utilisant 'make html' et en ajoutant de nouvelles pages via l'enregistrement des fichiers dans index.rst. Il présente également des exemples de code et les notations avancées du format ReStructuredText.

Make Your Own Quizzes and Flashcards

Convert your notes into interactive study material.

Get started for free

More Quizzes Like This

River Valley Civilizations
14 questions

River Valley Civilizations

StylishRockCrystal avatar
StylishRockCrystal
The Mysterious Sphinx
5 questions
On a Mission 3
8 questions

On a Mission 3

StimulativeForethought avatar
StimulativeForethought
The Great Sphinx of Giza
15 questions

The Great Sphinx of Giza

StableSynthesizer avatar
StableSynthesizer
Use Quizgecko on...
Browser
Browser