Full Circle Magazine FR

Outils pour utilisateurs

Outils du site

Piste : • linuxlab
issue130:tutoriel1

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentesRévision précédente
Prochaine révision		Révision précédente
issue130:tutoriel1 [2018/02/26 15:26] – d52frissue130:tutoriel1 [2018/03/01 16:20] (Version actuelle) – andre_domenech
Ligne 3: Ligne 3:
 If you have not used markup, you are missing out. Try it out. All you need it an editor such as vim/gvim or ??? – your choice – do not use a word processor.  So here is the basic layout for the markup and how to install Sphinx (by the way, Sphinx was written to create Python documentation).** If you have not used markup, you are missing out. Try it out. All you need it an editor such as vim/gvim or ??? – your choice – do not use a word processor.  So here is the basic layout for the markup and how to install Sphinx (by the way, Sphinx was written to create Python documentation).**
  
-Sphinx est une excellente application de mise en page de document : il peut créer du html, du latex, des pdf et plus encore. J'ai commencé à l'utiliser il y a quelques années pour écrire un court livre sur le bois tourné (Wood Turning). la raison d'avoir choisi Sphinx est sa capacité à créer différents styles en ne créant qu'un fichier config et en écrivant le texte dans reStructuredText. Voici la documentation : http://docutils.sourceforge.net/rst.html+Sphinx est une excellente application de mise en page de document : il peut créer du html, du latex, des pdf et plus encore. J'ai commencé à l'utiliser il y a quelques années pour écrire un court livre sur le bois tourné (Wood Turning). La raison pour laquelle j'ai choisi Sphinx est sa capacité à créer différents styles en ne créant qu'un fichier config et en écrivant le texte dans reStructuredText. Voici la documentation : http://docutils.sourceforge.net/rst.html
  
-Si vous n'avez utilisé markup, vous manquez quelque chose. Essayez. Tout ce dont vous avez besoin est un éditeur tel que vim/gvim ou ??? - à votre choix - n'utilisez-pas de traitement de texte. Voici la disposition de base pour markup et comment installer Sphinx (d'ailleurs, Sphinx a été écrit pour réaliser la documentation de Python).+Si vous n'avez pas utilisé markup, vous manquez quelque chose. Essayez-le. Tout ce dont vous avez besoin est un éditeur tel que vim/gvim ou ??? - à votre choix - n'utilisez pas de traitement de texte. Voici la disposition de base pour markup et comment installer Sphinx (d'ailleurs, Sphinx a été écrit pour réaliser la documentation de Python).
  
 **This was copied  from the Sphinx documentation page: http://www.sphinx-doc.org/en/stable/ **This was copied  from the Sphinx documentation page: http://www.sphinx-doc.org/en/stable/
Ligne 16: Ligne 16:
 • Contributed extensions: more than 50 extensions contributed by users in a second repository; most of them installable from PyPI** • Contributed extensions: more than 50 extensions contributed by users in a second repository; most of them installable from PyPI**
  
-Ceci a été recopié de la page de documentation de Sphinx : http://www.sphinx-doc.org/en/stable/+Ceci a été traduit à partir de la page de documentation de Sphinx : http://www.sphinx-doc.org/en/stable/
 • Formats de sortie : HTML ( y compris l'aide HTML de Windows), LaTeX (pour les versions imprimables en PDF), ePub, Texinfo, pages de manuel, texte brut. • Formats de sortie : HTML ( y compris l'aide HTML de Windows), LaTeX (pour les versions imprimables en PDF), ePub, Texinfo, pages de manuel, texte brut.
-• Références croisées étendues : markup sémantique et liens automatiques pour les fonctions, classes, citations, termes du glossaire et éléments d'information similaires +• Références croisées étendues : markup sémantique et liens automatiques pour les fonctions, classes, citations, termes du glossaire et éléments d'information similaires. 
-• Structure hiérarchique : définition facile de l'arborescence du document, avec des liens automatiques vers les frères, parents et enfants +• Structure hiérarchique : définition facile de l'arborescence du document, avec des liens automatiques vers les frères, parents et enfants. 
-• Indices automatiques : un index général tout comme des index pour les modules spécifiques à un langage +• Indices automatiques : un index général tout comme des index pour les modules spécifiques à un langage. 
-• Gestion du code : surlignage automatique utilisant le surligneur Pygments +• Gestion du code : surlignage automatique utilisant le surligneur Pygments. 
-• Extensions : test automatique de parties du code, inclusion de docstrings à partir de modules en Python (API docs) et +• Extensions : test automatique de segments du code, inclusion de docstrings à partir de modules en Python (API docs) et 
-• Extensions de la communauté : plus de 50 extensions dues à la contribution des utilisateurs dans un second dépôt : la plupart d'entre elles installables depuis PyPI.+• Extensions de la communauté : plus de 50 extensions dues à la contribution des utilisateurs dans un second dépôt, la plupart d'entre elles installables depuis PyPI.
  
  
Ligne 46: Ligne 46:
 After this is finished, you will have a index.rst file that looks like this, and you will have a conf.py file created from the questions you answered in the quickstart.** After this is finished, you will have a index.rst file that looks like this, and you will have a conf.py file created from the questions you answered in the quickstart.**
  
-Bon ! Installons Python et Sphinx ; la plupart des distributions arrivent avec Python installé ou au moins dans le gestionnaire de paquets. Vous pourrez devoir installer PyPI en utilisant pip :+Bon ! Installons Python et Sphinx ; la plupart des distributions arrivent avec Python installé ou au moins dans le gestionnaire de paquets. Vous devrez peut-être installer PyPI pour pouvoir utiliser pip :
  
 sudo apt install python-pip sudo apt install python-pip
  
-Installez Sphinx, soit depuis le paquet de la distribution soit par PyPi+Installez Sphinx, soit depuis le paquet de la distribution soit par PyPi :
  
 $ pip install Sphinx $ pip install Sphinx
  
-or+ou
  
 sudo apt install python-sphinx sudo apt install python-sphinx
  
-Ceci fonctionne mieux pour Ubuntu 16.04.01+Ceci fonctionne mieux pour Ubuntu 16.04.01.
  
 Puis lancez et répondez à toutes les questions ; assurez-vous de dire « oui » aux extensions autodoc. Si vous voulez créer d'abord un répertoire et changer pour ce répertoire, quickstart le fera pour vous : Puis lancez et répondez à toutes les questions ; assurez-vous de dire « oui » aux extensions autodoc. Si vous voulez créer d'abord un répertoire et changer pour ce répertoire, quickstart le fera pour vous :
Ligne 64: Ligne 64:
 $ sphinx-quickstart $ sphinx-quickstart
  
-Après avoir fini ceci, vous aurez un fichier index.rst qui ressemblera à ça et vous aurez un fichier conf.py créé à partir des réponses aux questions de quickstart.+Après avoir fini ceci, vous aurez un fichier index.rst qui ressemblera à ceci et vous aurez un fichier conf.py créé à partir des réponses aux questions de quickstart :
  
 **  ** 
Ligne 89: Ligne 89:
    tutorial    tutorial
  
-Ajoutez simplement vos chapitres etc dans ce fichier comme montré dans l'exemple du bas de la page précédente.+Ajoutez simplement vos chapitres, etc., dans ce fichier comme montré dans l'exemple du bas de la page précédente.
  
-Vous pourriez souhiater regarder dans le fichier conf.py pour voir si c'est ce que vous voulez ; sinon, faites les modifications. Puis tapez :+Vous souhaiterez peut-être regarder dans le fichier conf.py pour voir si c'est ce que vous voulez ; si ce n'est pas le cas, faites les modifications. Puis tapez :
  
 make html make html
  
-Ceci construira au format html la documentation que vous avez créé dans le répertoire _build/html. si vous voulez faire d'autres types de fichiers, vous verrez les répertoires créés dans le dossier _build. Exemple :+Ceci construira au format html la documentation que vous venez de créer, dans le répertoire _build/html. Si vous voulez faire d'autres types de fichiers, vous verrez les répertoires créés dans le dossier _build. Exemple :
  
 doctrees  html  latex  tex  xml doctrees  html  latex  tex  xml
  
-J'espère tout ceci utile à quelques uns qui aiment essayer de nouvelles façons d'utiliser Ubuntu/Linux.+J'espère que tout ceci sera utile aux personnes qui aiment essayer de nouvelles façons d'utiliser Ubuntu/Linux.
  
issue130/tutoriel1.1519655171.txt.gz · Dernière modification : 2018/02/26 15:26 de d52fr