Commit 1ada1fcf authored by Vincent Le gallic's avatar Vincent Le gallic

Documentation Sphinx, 1ère salve

parent 217fdacb
...@@ -6,6 +6,9 @@ media/photos/* ...@@ -6,6 +6,9 @@ media/photos/*
# Le fichier de secrets # Le fichier de secrets
secrets.py secrets.py
# La doc compilée
doc/build/
# Compiled source # # Compiled source #
################### ###################
*.pyc *.pyc
......
# 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 <target>' where <target> 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/ClientDjangopourlaNoteKfet2015.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ClientDjangopourlaNoteKfet2015.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/ClientDjangopourlaNoteKfet2015"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ClientDjangopourlaNoteKfet2015"
@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."
coverage:
@mkdir -p $(BUILDDIR)/coverage
@touch $(BUILDDIR)/coverage/python.txt
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo
@echo "Coverage test finished. The results are in $(BUILDDIR)/coverage."
htmlcov: coverage html
# -*- coding: utf-8 -*-
#
# Client Django pour la NoteKfet2015 documentation build configuration file, created by
# sphinx-quickstart on Mon Aug 26 12:53:12 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
# On a besoin d'importer les settings DJANGO
os.environ["DJANGO_SETTINGS_MODULE"] = "settings"
# 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('../..'))
sys.path.append(os.path.abspath('../../note/'))
# -- 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.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'Client Django pour la NoteKfet2015'
copyright = u'2013, Vincent Le Gallic'
# 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
# "<project> v<release> 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 <link> 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 = 'ClientDjangopourlaNoteKfet2015doc'
# -- 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', 'ClientDjangopourlaNoteKfet2015.tex', u'Client Django pour la NoteKfet2015 Documentation',
u'Vincent Le Gallic', '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', 'clientdjangopourlanotekfet2015', u'Client Django pour la NoteKfet2015 Documentation',
[u'Vincent Le Gallic'], 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', 'ClientDjangopourlaNoteKfet2015', u'Client Django pour la NoteKfet2015 Documentation',
u'Vincent Le Gallic', 'ClientDjangopourlaNoteKfet2015', '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'
# Documenter automatiquement les méthodes commençant par _
# et montrer l'héritage des classes
autodoc_default_flags = ['members', 'private-members', 'show-inheritance']
../../build/coverage/python.txt
\ No newline at end of file
.. Client Django pour la NoteKfet2015 documentation master file, created by
sphinx-quickstart on Mon Aug 26 12:53:12 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Bienvenue sur la documentation du Client Django pour la NoteKfet2015
====================================================================
Table des matières :
.. toctree::
:maxdepth: 2
:glob:
*
note/index
coverage/python
Index & co
==========
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
keep_alive -- Conservation de variables
=======================================
.. automodule:: keep_alive
:members:
forms -- Définition des formulaires
===================================
.. automodule:: note.forms
:members:
note -- La seule appli du projet
================================
Table des matières :
.. toctree::
:maxdepth: 2
:glob:
*
urls -- Quelle url est traitée par quelle fonction
==================================================
.. automodule:: note.urls
:members:
views -- Génération des pages
=============================
.. automodule:: note.views
:members:
secrets -- Module à part pour les settings sensibles
====================================================
.. automodule:: secrets_sample
:members:
settings -- Les paramètres de configuration du projet
=====================================================
.. automodule:: settings
:members:
urls -- Module urls principal
=============================
.. automodule:: urls
:members:
#!/usr/bin/env python #!/usr/bin/env python
# -*- encoding: utf-8 -*- # -*- encoding: utf-8 -*-
""" Module importé avec une méthode spéciale de Django
pour que les variables soient conservées d'une requête HTTP à l'autre.
"""
#: On stocke dans ce dictionnaire une map
#: idbde -> socket de connexion au serveur NK2015.
CONNS = {} CONNS = {}
#!/usr/bin/env python #!/usr/bin/env python
# -*- encoding: utf-8 -*- # -*- encoding: utf-8 -*-
from django.conf.urls import patterns, include, url """ Associe chaque url à une fonction de :py:mod:`note.views` qui
est chargée de générer la page correspondante.
"""
from django.conf.urls import patterns, include, url
#: Liste des patterns d'url
urlpatterns = patterns('note.views', urlpatterns = patterns('note.views',
# pages de base # pages de base
url(ur'^/*$', 'login_page'), url(ur'^/*$', 'login_page'),
......
...@@ -35,12 +35,15 @@ import threading ...@@ -35,12 +35,15 @@ import threading
import urllib import urllib
from django.utils.importlib import import_module from django.utils.importlib import import_module
#: Ce module est importé avec la méthode spéciale de Django
#: pour conserver ces valeurs entre deux requêtes HTTP du client
keep_alive = import_module('keep_alive') keep_alive = import_module('keep_alive')
"""Génération d'erreurs/warnings/success messages. """Génération d'erreurs/warnings/success messages.
Ils sont enregistrés dans la session (django.contrib.messages) Ils sont enregistrés dans la session (django.contrib.messages)
pour être affichés plus tard (juste après en général). pour être affichés à la prochaine page chargée (juste après en général).
""" """
...@@ -214,7 +217,7 @@ def login_NK(request, username, password, form, masque=[[], [], False]): ...@@ -214,7 +217,7 @@ def login_NK(request, username, password, form, masque=[[], [], False]):
return render_to_response('note/login.html', variables, context_instance=RequestContext(request)) return render_to_response('note/login.html', variables, context_instance=RequestContext(request))
def _get_socket(request, idbde): def _get_socket(request, idbde):
"""Récupère la socket dans keep_alive ou bien renvoie un redirect de fallback.""" """Récupère la socket dans :py:mod:`keep_alive` ou bien renvoie un redirect de fallback."""
if keep_alive.CONNS.has_key(idbde): if keep_alive.CONNS.has_key(idbde):
return (True, keep_alive.CONNS[idbde]) return (True, keep_alive.CONNS[idbde])
else: else:
...@@ -222,7 +225,7 @@ def _get_socket(request, idbde): ...@@ -222,7 +225,7 @@ def _get_socket(request, idbde):
return (MyHttpResponseRedirect(_gen_redirect_postlogin(request)), None) return (MyHttpResponseRedirect(_gen_redirect_postlogin(request)), None)
def socket_still_alive(request): def socket_still_alive(request):
"""Récupère dans keep_alive la socket de communication avec le serveur NK2015 """Récupère dans :py:mod:`keep_alive` la socket de communication avec le serveur NK2015
et vérifie que la session est toujours active. et vérifie que la session est toujours active.
* En cas de réussite, renvoie ``(True, <la socket de connexion>)``. * En cas de réussite, renvoie ``(True, <la socket de connexion>)``.
* En cas d'échec, renvoie ``(False, <un objet HttpResponse prêt à l'emploi>)``.""" * En cas d'échec, renvoie ``(False, <un objet HttpResponse prêt à l'emploi>)``."""
...@@ -608,24 +611,28 @@ def _gen_redirect_postlogin(request): ...@@ -608,24 +611,28 @@ def _gen_redirect_postlogin(request):
def standard_page(request, socket=False): def standard_page(request, socket=False):
"""Fonction appelée pour générer quasiment toutes les pages (pas login). """Fonction appelée pour générer quasiment toutes les pages (pas login).
Elle récupère la socket dnas keep_alive et vérifie que la session NK2015 n'a pas timeout.
Elle renvoie un booléen de succès puis <la socket avec le seuveur>, <un dico avec déjà des variables pour le template>) Elle récupère la socket dans :py:mod:`keep_alive` et vérifie que la session NK2015 n'a pas timeout.
ou un None, <render_to_response d'erreur>
Si socket=False, on ne se soucie pas de la socket et on renvoie None à sa place.""" Renvoie ``(bool, sock_ou_response, variables_standard)`` avec les cas suivants :
* ``(True, <une socket ouverte vers le serveur NK2015>, <un dico de variables de bases>)``
* ``(False, <un Http object utilisable>, {})``
* ``(True, None, <un dico de variables de base>)`` (dans le cas ``socket=False``)
"""
if request.session.get("logged", "no") == "ok": if request.session.get("logged", "no") == "ok":
# Le login a réussi # Le login a réussi
whoami = request.session["whoami"] whoami = request.session["whoami"]
donnees_standard = _fundamental_variables() variables_standard = _fundamental_variables()
donnees_standard["pages"] = request.session["pages"] variables_standard["pages"] = request.session["pages"]
donnees_standard["whoami"] = whoami variables_standard["whoami"] = whoami
if socket: if socket:
success, sock_ou_response = socket_still_alive(request) success, sock_ou_response = socket_still_alive(request)
if success: if success:
return (True, sock_ou_response, donnees_standard) return (True, sock_ou_response, variables_standard)
else: else:
return (False, sock_ou_response, {}) return (False, sock_ou_response, {})
else: else:
return (True, None, donnees_standard) return (True, None, variables_standard)
else: else:
# Le cookie Django a expiré ou est invalide # Le cookie Django a expiré ou est invalide
_add_error(request, settings.ERRMSG_DJANGO_SESSION_EXPIRED) _add_error(request, settings.ERRMSG_DJANGO_SESSION_EXPIRED)
......
#!/usr/bin/python #!/usr/bin/python
# -*- encoding: utf-8 -*- # -*- encoding: utf-8 -*-
""" Exemple de fichier ``secrets.py``, """ Attention, ce module n'est pas la vraie version utilisée par le projet.
car il n'est pas inclus dans le dépôt git. C'est une version de présentation incluse dans le dépôt git
à adapter et à renommer en enlevant le ``_sample``
À remplir avec les vraies valeurs des variables sensibles
À remplir avec les vraies valeurs des variables sensibles (à ne pas divulguer)
et à renommer en secrets.py et à renommer en secrets.py
""" """
......
#!/usr/bin/env python #!/usr/bin/env python
# -*- encoding: utf-8 -*- # -*- encoding: utf-8 -*-
""" Module urls principal.
Sert essentiellement à rediriger vers :py:mod:`note.urls`.
Rajoute aussi la config pour servir les fichiers statiques quand on
est en mode DEBUG.
"""
from django.conf.urls import patterns, include, url from django.conf.urls import patterns, include, url
import settings import settings
...@@ -9,7 +17,7 @@ if settings.DEBUG: ...@@ -9,7 +17,7 @@ if settings.DEBUG:
# On n'utilise pas ça en prod # On n'utilise pas ça en prod
from django.contrib.staticfiles.urls import staticfiles_urlpatterns from django.contrib.staticfiles.urls import staticfiles_urlpatterns
# custom 404 #: Erreur 404 custom
handler404 = "note.views.page_not_found" handler404 = "note.views.page_not_found"
from django.contrib import admin from django.contrib import admin
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment