From 8db690c316a9082918329395fb7392b68b2f5502 Mon Sep 17 00:00:00 2001 From: Vincent Le Gallic Date: Tue, 26 Mar 2013 17:25:19 +0100 Subject: [PATCH] =?UTF-8?q?[doc]=20doc=20en=20Sphinx=20(seulement=20pour?= =?UTF-8?q?=20la=20partie=20config=20pour=20le=20moment).=20=C3=80=20conti?= =?UTF-8?q?nuer=20!?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/Makefile | 153 +++++++++++ doc/source/conf.py | 250 ++++++++++++++++++ doc/source/gestion/config/firewall.rst | 6 + doc/source/gestion/config/impression.rst | 6 + doc/source/gestion/config/index.rst | 11 + doc/source/gestion/config/mac_prise.rst | 6 + .../gestion/config/mails/demenagement.rst | 6 + doc/source/gestion/config/mails/index.rst | 10 + doc/source/gestion/config/mails/p2p.rst | 6 + doc/source/gestion/config/mails/upload.rst | 6 + doc/source/gestion/config/p2p.rst | 6 + doc/source/gestion/config/upload.rst | 6 + doc/source/gestion/config/virus.rst | 6 + doc/source/gestion/index.rst | 9 + doc/source/index.rst | 22 ++ 15 files changed, 509 insertions(+) create mode 100644 doc/Makefile create mode 100644 doc/source/conf.py create mode 100644 doc/source/gestion/config/firewall.rst create mode 100644 doc/source/gestion/config/impression.rst create mode 100644 doc/source/gestion/config/index.rst create mode 100644 doc/source/gestion/config/mac_prise.rst create mode 100644 doc/source/gestion/config/mails/demenagement.rst create mode 100644 doc/source/gestion/config/mails/index.rst create mode 100644 doc/source/gestion/config/mails/p2p.rst create mode 100644 doc/source/gestion/config/mails/upload.rst create mode 100644 doc/source/gestion/config/p2p.rst create mode 100644 doc/source/gestion/config/upload.rst create mode 100644 doc/source/gestion/config/virus.rst create mode 100644 doc/source/gestion/index.rst create mode 100644 doc/source/index.rst diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 00000000..df5f2ed1 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/LesscriptsduCrns.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LesscriptsduCrns.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/LesscriptsduCrns" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/LesscriptsduCrns" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 00000000..dfa512d9 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,250 @@ +# -*- coding: utf-8 -*- +# +# Les scripts du Cr@ns documentation build configuration file, created by +# sphinx-quickstart on Wed Mar 20 18:39:09 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('../..')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Les scripts du Cr@ns' +copyright = u'2013, Les nounous du Cr@ns' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '' +# The full version, including alpha/beta/rc tags. +release = '' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +language = 'FR' + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%d %b %Y %T' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'LesscriptsduCrnsdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'LesscriptsduCrns.tex', u'Les scripts du Cr@ns Documentation', + u'Les \\textless{}a href="https://wiki.crans.org/CransNounous"\\textgreater{}nounous\\textless{}/a\\textgreater{} du Cr@ns', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'lesscriptsducrns', u'Les scripts du Cr@ns Documentation', + [u'Les nounous du Cr@ns'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'LesscriptsduCrns', u'Les scripts du Cr@ns Documentation', + u'Les nounous du Cr@ns', 'LesscriptsduCrns', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} + +# Pour afficher la doc dans l'ordre du code (par défaut, alphabétique) +autodoc_member_order = 'bysource' +autodoc_default_flags = ['members', 'private-members', 'show-inheritance'] diff --git a/doc/source/gestion/config/firewall.rst b/doc/source/gestion/config/firewall.rst new file mode 100644 index 00000000..43f5b7ef --- /dev/null +++ b/doc/source/gestion/config/firewall.rst @@ -0,0 +1,6 @@ +firewall -- Variables de configuration pour le firewall +======================================================= + +.. automodule:: gestion.config.firewall + :members: + diff --git a/doc/source/gestion/config/impression.rst b/doc/source/gestion/config/impression.rst new file mode 100644 index 00000000..97046afb --- /dev/null +++ b/doc/source/gestion/config/impression.rst @@ -0,0 +1,6 @@ +impression -- Variables de configuration pour l'impression +========================================================== + +.. automodule:: gestion.config.impression + :members: + diff --git a/doc/source/gestion/config/index.rst b/doc/source/gestion/config/index.rst new file mode 100644 index 00000000..10a6ee94 --- /dev/null +++ b/doc/source/gestion/config/index.rst @@ -0,0 +1,11 @@ +Configuration des scripts +========================= + +Table des matières : + +.. toctree:: + :maxdepth: 2 + :glob: + + * + mails/index diff --git a/doc/source/gestion/config/mac_prise.rst b/doc/source/gestion/config/mac_prise.rst new file mode 100644 index 00000000..96e4e296 --- /dev/null +++ b/doc/source/gestion/config/mac_prise.rst @@ -0,0 +1,6 @@ +mac_prise -- Variables de configuration pour mac_prises +======================================================= + +.. automodule:: gestion.config.mac_prise + :members: + diff --git a/doc/source/gestion/config/mails/demenagement.rst b/doc/source/gestion/config/mails/demenagement.rst new file mode 100644 index 00000000..f2b2d69d --- /dev/null +++ b/doc/source/gestion/config/mails/demenagement.rst @@ -0,0 +1,6 @@ +demenagement -- Template de mail pour le déménagement +===================================================== + +.. automodule:: gestion.config.mails.demenagement + :members: + diff --git a/doc/source/gestion/config/mails/index.rst b/doc/source/gestion/config/mails/index.rst new file mode 100644 index 00000000..13e3d00a --- /dev/null +++ b/doc/source/gestion/config/mails/index.rst @@ -0,0 +1,10 @@ +Configuration des mails automatiquement envoyés +=============================================== + +Table des matières : + +.. toctree:: + :maxdepth: 2 + :glob: + + * diff --git a/doc/source/gestion/config/mails/p2p.rst b/doc/source/gestion/config/mails/p2p.rst new file mode 100644 index 00000000..7b7c5029 --- /dev/null +++ b/doc/source/gestion/config/mails/p2p.rst @@ -0,0 +1,6 @@ +p2p -- Templates de mails pour le peer-to-peer +============================================== + +.. automodule:: gestion.config.mails.p2p + :members: + diff --git a/doc/source/gestion/config/mails/upload.rst b/doc/source/gestion/config/mails/upload.rst new file mode 100644 index 00000000..ad004bec --- /dev/null +++ b/doc/source/gestion/config/mails/upload.rst @@ -0,0 +1,6 @@ +upload -- Templates de mails pour l'upload +========================================== + +.. automodule:: gestion.config.mails.upload + :members: + diff --git a/doc/source/gestion/config/p2p.rst b/doc/source/gestion/config/p2p.rst new file mode 100644 index 00000000..86f1a945 --- /dev/null +++ b/doc/source/gestion/config/p2p.rst @@ -0,0 +1,6 @@ +p2p -- Variables de configuration pour le peer-to-peer +====================================================== + +.. automodule:: gestion.config.p2p + :members: + diff --git a/doc/source/gestion/config/upload.rst b/doc/source/gestion/config/upload.rst new file mode 100644 index 00000000..115b6cc3 --- /dev/null +++ b/doc/source/gestion/config/upload.rst @@ -0,0 +1,6 @@ +upload -- Variables de configuration pour l'upload +================================================== + +.. automodule:: gestion.config.upload + :members: + diff --git a/doc/source/gestion/config/virus.rst b/doc/source/gestion/config/virus.rst new file mode 100644 index 00000000..7ed793d0 --- /dev/null +++ b/doc/source/gestion/config/virus.rst @@ -0,0 +1,6 @@ +virus -- Variables de configuration pour la détection de virus +============================================================== + +.. automodule:: gestion.config.virus + :members: + diff --git a/doc/source/gestion/index.rst b/doc/source/gestion/index.rst new file mode 100644 index 00000000..fc8073de --- /dev/null +++ b/doc/source/gestion/index.rst @@ -0,0 +1,9 @@ +gestion - scripts de gestion du Cr@ns +===================================== + +Table des matières : + +.. toctree:: + :maxdepth: 2 + + config/index diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 00000000..3cdb424e --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,22 @@ +.. Les scripts du Cr@ns documentation master file, created by + sphinx-quickstart on Wed Mar 20 18:39:09 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Documentation sphinx des scripts du Cr@ns +========================================= + +Table des matières : + +.. toctree:: + :maxdepth: 5 + + gestion/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` +