Salome HOME
Revert "Synchronize adm files"
[modules/med.git] / src / MEDOP / doc / sphinx / conf.py.in
index 8259ef9166f462d786cc010ee0953f9de0c5961a..aaf8a8c3632350a07ee2d1c2e51ffc92e63f42db 100644 (file)
@@ -34,7 +34,7 @@ extensions = ['sphinx.ext.autodoc']
 intersphinx_mapping = {'http://docs.python.org': None}
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = [os.path.join('@srcdir@','_templates')]
+templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','_templates')]
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -47,16 +47,16 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'MED, Manipulation de champs dans SALOME'
-copyright = '2010 CEA/DEN, EDF R&D, OPEN CASCADE, G. Boulant, A. Geay'
+copyright = '2010-2014 CEA/DEN, EDF R&D, OPEN CASCADE, G. Boulant, A. Geay'
 
 # 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 = '@SHORT_VERSION@'
+version = '@SALOMEMED_VERSION@'
 # The full version, including alpha/beta/rc tags.
-release = '@VERSION@'
+release = '@SALOMEMED_VERSION@'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -75,6 +75,11 @@ language = 'fr'
 # for source files.
 exclude_trees = ['.build','ref','images','CVS','.svn']
 
+# A list of glob-style patterns that should be excluded when looking for source
+# files. They are matched against the source file names relative to the
+# source directory, using slashes as directory separators on all platforms.
+exclude_patterns = ['**/CVS']
+
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
 
@@ -132,7 +137,7 @@ html_style = 'medop.css'
 # 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 = [os.path.join('@srcdir@','_static')]
+html_static_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','_static')]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -176,11 +181,17 @@ htmlhelp_basename = 'medopdoc'
 # Options for LaTeX output
 # ------------------------
 
-# The paper size ('letter' or 'a4').
-latex_paper_size = 'a4'
-
-# The font size ('10pt', '11pt' or '12pt').
-latex_font_size = '10pt'
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    'papersize': 'a4paper',
+    # Select another font family
+    #'fontpkg':'\\usepackage{eucal}',
+    # get rid off blank pages
+    'classoptions': ',openany,oneside',
+    'babel' : '\\usepackage[english]{babel}',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
+}
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
@@ -188,16 +199,17 @@ latex_documents = [
   ('index', 'medop-alldoc.tex', 'Documentation du module MED', 'G. Boulant', 'manual'),
   ('medop-specifications', 'medop-specifications.tex', 'Module MED - Specifications', 'G. Boulant', 'manual'),
   ('medop-develguide', 'medop-develguide.tex', 'Module MED - Guide de developpement', 'G. Boulant', 'manual'),
-  ('medop-userguide', 'medop-userguide.tex', 'Module MED - Guide d\'utilisation', 'G. Boulant', 'manual')
+  ('medop-userguide-gui', 'medop-userguide-gui.tex', 'Module MED - Guide d\'utilisation de l\'interface graphique', 'G. Boulant', 'howto'),
+  ('medop-userguide-api', 'medop-userguide-api.tex', 'MEDMEM library - Starter guide for users', 'G. Boulant', 'howto')
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+latex_logo = os.path.join("@CMAKE_CURRENT_SOURCE_DIR@","_static","head.png")
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+latex_use_parts = True
 
 # Additional stuff for the LaTeX preamble.
 #latex_preamble = ''
@@ -207,3 +219,10 @@ latex_documents = [
 
 # If false, no module index is generated.
 latex_use_modindex = False
+
+# Definition of substitute variables for rst texts
+# ------------------------------------------------
+# The rst_epilog can be used to define variable in conf.py and use the
+# values of these variables in the rst text files.
+srcdir = '@CMAKE_CURRENT_SOURCE_DIR@'
+rst_epilog = '.. |SPHINXDOC_SRCDIR| replace:: %s' % srcdir