Salome HOME
remove remaining is_salome_product occurences
[tools/sat.git] / doc / src / conf.py
index 320a7a5b015376c3adba2a1389b79e86ef579b14..5e37a670f6e503cebd01c0ba2256733a65c2d582 100644 (file)
 import sys
 import os
 
+
+# https://stackoverflow.com/questions/23462494/how-to-add-a-custom-css-file-to-sphinx
+# this needs realpath(custom), cause problem on relocated git clone, 
+# so use file link instead in _themes/alabaster: ln -s ../../../../src/custom.css custom.css
+# def setup(app):
+#     custom = os.path.join('src', 'custom.css')
+#     print "setup add_stylesheet\n  %s as\n  %s" % (custom, os.path.realpath(custom))
+#     app.add_stylesheet(os.path.realpath(custom))
+
 # 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.
@@ -26,7 +35,7 @@ import os
 
 # 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.mathjax', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode']
 
 # do not use rst_prolog please use doc/rst_prolog.rst and '.. include:: ../rst_prolog.rst'
 # https://github.com/sphinx-doc/sphinx/issues/2445
@@ -45,16 +54,16 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'salomeTools'
-copyright = u'2018, CEA'
+copyright = u'2019, CEA'
 
 # 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 = '5.0'
+version = '5.4'
 # The full version, including alpha/beta/rc tags.
-release = '5.0.0dev'
+release = '5.4.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -101,7 +110,26 @@ html_theme = 'alabaster' #added in _theme dir
 # 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 = {}
+html_theme_options = {
+    #'logo': 'logo.png',
+    #'github_user': 'bitprophet',
+    #'github_repo': 'alabaster',
+    #'description': 'MYYY DESCRIPTION',
+    #'sidebar_includehidden': True,
+    #'sidebar_collapse': True,
+    #'show_powered_by': False,
+    'show_related': True,
+    'fixed_sidebar': False,
+    'page_width': '1000px',
+    'sidebar_width': '250px',
+    'font_size': '0.9em', #'1.0625em',
+    'code_font_size': '0.8em',
+    #'note_bg': '#eee',
+    'pre_bg': '#fee', # code-block background
+    #'gray_1': '#00f',
+    #'gray_2': '#f00',
+    #'gray_3': '#0f0',
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ["../_themes/alabaster", ]
@@ -183,6 +211,9 @@ latex_elements = {
 
   # Additional stuff for the LaTeX preamble.
   #'preamble': '',
+
+  # http://www.sphinx-doc.org/en/master/latex.html
+  'sphinxsetup': 'verbatimwithframe=false, VerbatimColor={rgb}{.98,.94,.94}',
 }
 
 
@@ -208,10 +239,10 @@ latex_documents = [
 #latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+latex_show_pagerefs = True
 
 # If true, show URL addresses after external links.
-latex_show_urls = True
+latex_show_urls = 'footnote' # sphinx version 1.7 # True
 
 # Additional stuff for the LaTeX preamble.
 #latex_preamble = ''
@@ -232,7 +263,4 @@ man_pages = [
      [u'CEA DEN/DANS/DM2S/STMF/LGLS'], 1)
 ]
 
-# Append source folder to path in order to enable autodoc
-currentPath = os.path.dirname(__file__)
-print "file conf.py currentPath", currentPath
-sys.path.append(os.path.join(currentPath, '..', '..'))
+