X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fconf.py.in;h=5f37720dc6b5eddf64ef8a76b37a26c20a6f4098;hb=4843811e2be7670a4fe2140a8f883a10b1da172f;hp=b5a525db2c7b35eaaf53ea43cec2e8f1b2ff80bc;hpb=33fc632115e554b442fcdf71a0da69a4f58ea8d3;p=modules%2Fyacs.git diff --git a/doc/conf.py.in b/doc/conf.py.in index b5a525db2..5f37720dc 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -12,6 +12,7 @@ # serve to show the default. import sys, os +import sphinx # If your extensions are in another directory, add it here. If the directory # is relative to the documentation root, use os.path.abspath to make it @@ -24,11 +25,17 @@ import sys, 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'] +try: + import sphinx_rtd_theme + extensions += ['sphinx_rtd_theme'] + use_rtd_theme = True +except: + use_rtd_theme = False #add pdfbuilder to build a pdf with rst2pdf #extensions = ['rst2pdf.pdfbuilder'] # 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' @@ -41,16 +48,16 @@ master_doc = 'index' # General information about the project. project = 'yacs' -copyright = '2007-2012 CEA/DEN, EDF R&D.' +copyright = '2007-2023 CEA, EDF.' # 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 = '@SALOMEYACS_VERSION@' # The full version, including alpha/beta/rc tags. -release = '@VERSION@' +release = '@SALOMEYACS_VERSION@' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -69,6 +76,11 @@ release = '@VERSION@' # for source files. exclude_trees = ['.build','ref','images','CVS'] +# 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 @@ -92,7 +104,17 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. -html_theme = 'default' +if use_rtd_theme: + html_theme = 'sphinx_rtd_theme' +else: + html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic' + +themes_options = {} +themes_options['classic'] = { + 'body_max_width':'none', + 'body_min_width':0, +} +html_theme_options = themes_options.get(html_theme, {}) # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -113,7 +135,7 @@ html_theme = 'default' # 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.