]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor documentation configuration corrections
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 25 May 2020 15:35:13 +0000 (17:35 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 25 May 2020 15:35:13 +0000 (17:35 +0200)
doc/en/conf.py
doc/fr/conf.py

index 3cba9603b7136ea55451fbb82c078a6daa5cb921..7481788ca75a50f5d9e19b475497a0a902d91817 100644 (file)
@@ -24,7 +24,7 @@
 
 import sys, os, time, sphinx, logging
 
-# -- ADAO version information --------------------------------------------------
+# -- Module version information --------------------------------------------------
 
 try:
     sys.path.append(os.path.abspath("../../bin"))
@@ -103,7 +103,8 @@ html_search_language = language
 html_favicon         = 'resources/ADAO_favicon.ico'
 
 # -- Options for HTMLHelp output -----------------------------------------------
-htmlhelp_basename    = 'ADAOdoc'
+
+htmlhelp_basename    = module_version.name+'doc'
 
 # -- Options for LaTeX output --------------------------------------------------
 
@@ -113,23 +114,25 @@ latex_elements = {
     'figure_align': 'htbp',
 }
 latex_documents = [
-  ('index', 'ADAO.tex', doctitle,
+  ('index', '%s.tex'%module_version.name, doctitle,
    author, 'manual'),
 ]
 
 # -- Options for manual page output --------------------------------------------
 
 man_pages = [
-    (master_doc, 'adao', doctitle,
+    (master_doc, '%s'%module_version.name, doctitle,
      [author], 1)
 ]
 
 # -- Options for Texinfo output ------------------------------------------------
+
 texinfo_documents = [
-    (master_doc, 'ADAO', doctitle,
-     author, 'ADAO', docfull,
+    (master_doc, '%s'%module_version.name, doctitle,
+     author, '%s'%module_version.name, docfull,
      'Miscellaneous'),
 ]
+
 # -- Options for Epub output ---------------------------------------------------
 
 epub_title         = doctitle
@@ -140,9 +143,13 @@ epub_exclude_files = ['search.html']
 
 # -- Options for PDF output ----------------------------------------------------
 
-pdf_documents = [
-    ('contents', u'ADAO', u'ADAO', author, dict(pdf_compressed = True)),
-]
+pdf_documents = [(
+    'contents',
+    u'%s'%module_version.name,
+    u'%s'%module_version.name,
+    author,
+    dict(pdf_compressed = True),
+),]
 pdf_stylesheets = ['sphinx','kerning','a4']
 pdf_compressed = True
 pdf_inline_footnotes = True
index 70dd301b29405d6292bfdcb081e1c84d5c5deaa9..9581ecc29bd51f165bd5015d3180b5cefbf7fa28 100644 (file)
@@ -24,7 +24,7 @@
 
 import sys, os, time, sphinx, logging
 
-# -- ADAO version information --------------------------------------------------
+# -- Module version information --------------------------------------------------
 
 try:
     sys.path.append(os.path.abspath("../../bin"))
@@ -103,7 +103,8 @@ html_search_language = language
 html_favicon         = 'resources/ADAO_favicon.ico'
 
 # -- Options for HTMLHelp output -----------------------------------------------
-htmlhelp_basename    = 'ADAOdoc'
+
+htmlhelp_basename    = module_version.name+'doc'
 
 # -- Options for LaTeX output --------------------------------------------------
 
@@ -113,23 +114,25 @@ latex_elements = {
     'figure_align': 'htbp',
 }
 latex_documents = [
-  ('index', 'ADAO.tex', doctitle,
+  ('index', '%s.tex'%module_version.name, doctitle,
    author, 'manual'),
 ]
 
 # -- Options for manual page output --------------------------------------------
 
 man_pages = [
-    (master_doc, 'adao', doctitle,
+    (master_doc, '%s'%module_version.name, doctitle,
      [author], 1)
 ]
 
 # -- Options for Texinfo output ------------------------------------------------
+
 texinfo_documents = [
-    (master_doc, 'ADAO', doctitle,
-     author, 'ADAO', docfull,
+    (master_doc, '%s'%module_version.name, doctitle,
+     author, '%s'%module_version.name, docfull,
      'Miscellaneous'),
 ]
+
 # -- Options for Epub output ---------------------------------------------------
 
 epub_title         = doctitle
@@ -140,9 +143,13 @@ epub_exclude_files = ['search.html']
 
 # -- Options for PDF output ----------------------------------------------------
 
-pdf_documents = [
-    ('contents', u'ADAO', u'ADAO', author, dict(pdf_compressed = True)),
-]
+pdf_documents = [(
+    'contents',
+    u'%s'%module_version.name,
+    u'%s'%module_version.name,
+    author,
+    dict(pdf_compressed = True),
+),]
 pdf_stylesheets = ['sphinx','kerning','a4']
 pdf_compressed = True
 pdf_inline_footnotes = True