%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% by Lilian Besson, (c) 2013, 2014 %% http://besson.qc.to/publis/seminaire_crans/ %% mailto:Lilian.BESSON[@]ens-cachan[.]fr \documentclass[french, 10pt]{beamer} % Add the option ''', handout''' to print the slides. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \usepackage{naereen} \usepackage{naereenbeamer} \newcommand{\mytitle}[0]{Apprendre à utiliser \it{Sphinx} en 1 heure et quelques slides} \newcommand{\mysubtitle}[0]{Séminaire \tt{Cr@ns} 2013/2014} % \graphicspath{ {./} } %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% hyperref options \usepackage{hyperref} %[pdfcenterwindow=true, %pdfstartview=Fit, %plainpages=false, %pdftoolbar=false, %pdfmenubar=false, %backref, %linkcolor=black,citecolor=black,filecolor=black,urlcolor=black %pdftitle={\mytitle{}}, %pdfauthor={Lilian Besson},]{hyperref} \hypersetup{pdfstartview={Fit}} % fits the presentation to the window when first displayed %% BEGIN of pygmentize.tex %% Generated with `pygmentize -f tex -S colorful > ./pygmentize.tex` \input{pygmentize} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \title[\mysubtitle{}]{\mytitle{}} \subtitle{\mysubtitle{}} %Votre nom, celui de votre encadrant, le nom de son équipe/labo \author[Lilian Besson]{ \href{http://perso.crans.org/besson}{\Large{Lilian Besson}} % \footnote{Please contact me by email (\href{mailto:Lilian.Besson@ens-cachan.fr}{Lilian.Besson@ens-cachan.fr}) for any questions, comments or problems about this document.} } \institute[\tt{CRANS}]{\large{\tt{ENS Cachan} et \tt{CRANS}}} %\date{Lundi 9 Septembre 2013} \date{\today{}} \makeindex %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \begin{document} \DeclareGraphicsExtensions{.pdf,.png,.jpg,.svg} \setcounter{framenumber}{1} %------------------------------------------------------------------------------ % Début du contenu du document %------------------------------------------------------------------------------ % Premier slide pour le Titre ! \begin{frame}[plain] \addtocounter{framenumber}{-1}% Correct total frame count \addtocounter{framenumber}{-1}% Correct total frame count \titlepage{} \begin{center} \begin{small} %TR:Do not hesitate to contact me by email: %TR:N'hésitez pas à me re-contacter \textcolor{dkgreen}{\href{mailto:Lilian.BESSON@crans.org}{Lilian.BESSON@crans.org}} %TR:These slides, and the resources used for the examples are available on-line: Ces slides et les ressources utilisées pour les exemples sont disponibles en lignes \urlg{http://perso.crans.org/besson/publis/seminaire_crans/} \end{small} \end{center} \end{frame} %------------------------------------------------------------------------------ \section{Présentation} %TR: Presentation \subsection{Plan} \begin{frame}%[plain] %%% a supprimer \frametitle{Plan} %TR:Outline % \begin{tiny} \tableofcontents % \end{tiny} \begin{center} \Large{\textcolor{red}{Surtout, n'hésitez pas à m'interrompre !}} %TR:Please, interrupt me if you have any question! \end{center} \end{frame} %------------------------------------------------------------------------------ %------------------------------------------------------------------------------ \subsection{De quoi va-t-on parler ?} \begin{frame} \frametitle{Documentation de code} \begin{exampleblock}{Quel langage ciblé ?} \begin{itemize} \item[$\hookrightarrow$] \tt{Python} le plus utilisé pour les scripts du Crans \hfill{} (versions 2 ou 3). \end{itemize} \end{exampleblock} % \vspace{10pt} \begin{exampleblock}<1->{Pourquoi documenter ? \hfill{} (\it{cf} séminaire du 19 Février 2013)} \begin{description}%[<+->] \item[propreté] documenter nécessite un code \bf{propre}, \item[partager] plus facile de re-travailler sur un code documenté, \item[renseigner] plus de transparence, montre un soucis de clarté. \end{description} \end{exampleblock} % \vspace{10pt} \begin{exampleblock}<1->{Comment} Avec Sphinx, le générateur de documentation officiel pour le langage Python. Référence : \urlb{http://sphinx-doc.org}. \end{exampleblock} % \vspace{10pt} \begin{exampleblock}<1->{Déjà déployé} Sphinx est déjà utilisé depuis Mars 2013 par le Crans, voir : \urlb{http://doc.crans.org/}. Un exemple concret : \urlb{http://doc.crans.org/lc_ldap/lc_ldap/attributs.html}. \end{exampleblock} \end{frame} %------------------------------------------------------------------------------ %------------------------------------------------------------------------------ \section{Conclusion et perspectives} %TR: Sum-up and perspectives %------------------------------------------------------------------------------ \subsection{Résumé} %------------------------------------------------------------------------------ \begin{frame}%[plain] \frametitle{Conclusion} \begin{large} \begin{block}{Nous avons présenté} %TR: What we presented \begin{description} \item[sphinx-quickstart] pour facilement initialiser un projet Sphinx, \item[\tt{reST}] un langage à balise \it{léger} pour mettre en page les commentaires Python (\it{docstring}) et rédiger la documentation, \item[sphinx-build] pour construire la documentation (à la main), \item[\tt{Makefile}] un \tt{Makefile} générique utile pour facilement construire la doc, \item[\it{Jinja}] une syntaxe simple pour changer l'apparence des pages web produites avec Sphinx. \end{description} \end{block} \end{large} \end{frame} %------------------------------------------------------------------------------ \subsection*{Merci} %TR:Thanks %------------------------------------------------------------------------------ \begin{frame} \frametitle{Merci d'avoir écouté !} %TR:Thanks for listening! %\addtocounter{framenumber}{-1}% Correct total frame count \begin{center} \Huge{Des questions ?} %TR:Any question? \end{center} \vspace{20pt} \begin{large} \begin{exampleblock}{Pour en savoir plus ?} %TR:More? \begin{itemize} \item[$\hookrightarrow$] parcourir mon site (\urlb{http://perso.crans.org/besson}), fait avec Sphinx, pour des idées de personnalisation (intégrer Google Analytics, des raccourcis clavier, Google Translate et plein d'autres trucs!) \item[$\hookrightarrow$] regarder la bibliographie. %TR:use the bibliography \end{itemize} \end{exampleblock} \end{large} \end{frame} %------------------------------------------------------------------------------ %------------------------------------------------------------------------------ \appendixBeamer{} %------------------------------------------------------------------------------ \section*{Annexe} %------------------------------------------------------------------------------ \subsection*{Bibliographie} %TR:Bibliography %------------------------------------------------------------------------------ \begin{frame} \addtocounter{framenumber}{-1}% Correct total frame count \frametitle{Bibliographie} %TR:y %% \frametitle{Bibliographie} %TR:y \begin{thebibliography}{10} \beamertemplatearticlebibitems{} \bibitem{FN72} Richard~Fikes and Nils~Nilsson. \newblock \tt{[FN72]} {\em Strips: A new approach to the application of theorem proving to problem solving}. \newblock Artificial intelligence, 2(3): 189–208, 1972. \beamertemplatearticlebibitems{} \bibitem{Liu02} Yangmei~Liu. \newblock \tt{[Liu02]} {\em A Hoare-style proof system for robot programs}. \newblock AAAI, 2002. \beamertemplatearticlebibitems{} \bibitem{Mal11} Herbert~Malte. \newblock \tt{[Mal11]} {\em pyperplan, a lightweight STRIPS planner, written in python 3}. \newblock \href{https://bitbucket.org/malte/pyperplan}{\tt{https://bitbucket.org/malte/pyperplan}}, 2011. \end{thebibliography} \end{frame} %------------------------------------------------------------------------------ %------------------------------------------------------------------------------ \end{document} %% END of slides.tex %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%