From 8eda0c3c6d688da2f74167c046d880e930f0f4b2 Mon Sep 17 00:00:00 2001 From: Paul RASCLE Date: Mon, 7 Mar 2016 18:32:29 +0100 Subject: [PATCH] amorce doc Sphinx blocFissure --- resources/SalomeApp.xml.in | 1 + src/Tools/blocFissure/CMakeLists.txt | 1 + src/Tools/blocFissure/doc/CMakeLists.txt | 63 ++++++++ src/Tools/blocFissure/doc/conf.py.in | 179 +++++++++++++++++++++++ src/Tools/blocFissure/doc/index.rst | 39 +++++ 5 files changed, 283 insertions(+) create mode 100755 src/Tools/blocFissure/doc/CMakeLists.txt create mode 100644 src/Tools/blocFissure/doc/conf.py.in create mode 100644 src/Tools/blocFissure/doc/index.rst diff --git a/resources/SalomeApp.xml.in b/resources/SalomeApp.xml.in index 94c0d894e..260e2b51c 100644 --- a/resources/SalomeApp.xml.in +++ b/resources/SalomeApp.xml.in @@ -122,6 +122,7 @@ +
diff --git a/src/Tools/blocFissure/CMakeLists.txt b/src/Tools/blocFissure/CMakeLists.txt index 3b69e0f83..092977b32 100644 --- a/src/Tools/blocFissure/CMakeLists.txt +++ b/src/Tools/blocFissure/CMakeLists.txt @@ -20,6 +20,7 @@ ADD_SUBDIRECTORY(CasTests) ADD_SUBDIRECTORY(gmu) ADD_SUBDIRECTORY(materielCasTests) +ADD_SUBDIRECTORY(doc) IF(SALOME_BUILD_GUI) ADD_SUBDIRECTORY(ihm) diff --git a/src/Tools/blocFissure/doc/CMakeLists.txt b/src/Tools/blocFissure/doc/CMakeLists.txt new file mode 100755 index 000000000..c1b0efe46 --- /dev/null +++ b/src/Tools/blocFissure/doc/CMakeLists.txt @@ -0,0 +1,63 @@ +# Copyright (C) 2012-2015 EDF R&D +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +SET(RSTFILES + index.rst +) + +SET(SPHINXOPTS ) +SET(SOURCEDIR ${CMAKE_CURRENT_SOURCE_DIR}) +SET(PAPEROPT_a4 -D latex_paper_size=a4) +SET(ALLSPHINXOPTS -d doctrees ${PAPEROPT_a4} ${SPHINXOPTS} ${SOURCEDIR}) + +SALOME_CONFIGURE_FILE(conf.py.in conf.py) + +ADD_CUSTOM_TARGET(BUILD_HTML ALL + COMMAND ${CMAKE_COMMAND} -E make_directory html + COMMAND ${CMAKE_COMMAND} -E make_directory doctrees + COMMAND ${SPHINX_EXECUTABLE} -c ${CMAKE_CURRENT_BINARY_DIR} -b html ${ALLSPHINXOPTS} html + DEPENDS ${RSTFILES} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} +) + +ADD_CUSTOM_TARGET(BUILD_PDF ALL + COMMAND ${CMAKE_COMMAND} -E make_directory latex + COMMAND ${SPHINX_EXECUTABLE} -c ${CMAKE_CURRENT_BINARY_DIR} -b latex ${ALLSPHINXOPTS} latex + COMMAND make -C latex all-pdf + DEPENDS ${RSTFILES} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} +) + +INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ + DESTINATION ${SALOME_INSTALL_DOC}/gui/SMESH/blocFissure + PATTERN ".buildinfo" EXCLUDE +) + +INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/latex/blocFissure.pdf DESTINATION ${SALOME_INSTALL_DOC}/gui/SMESH/blocFissure) + +#SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees -D latex_paper_size=a4 ${CMAKE_CURRENT_SOURCE_DIR} docutils) +#SALOME_GENERATE_ENVIRONMENT_SCRIPT(_cmd env_script "${SPHINX_EXECUTABLE}" "${_cmd_options}") + +#ADD_CUSTOM_TARGET(html_docs_ZCracksPlug COMMAND ${_cmd}) + +#INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target html_docs_ZCracksPlug)") +#INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docutils/ DESTINATION ${SALOME_INSTALL_DOC}/gui/SMESH/zcracks) + +#SET(make_clean_files docutils doctrees) +#SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${make_clean_files}") diff --git a/src/Tools/blocFissure/doc/conf.py.in b/src/Tools/blocFissure/doc/conf.py.in new file mode 100644 index 000000000..47bfec558 --- /dev/null +++ b/src/Tools/blocFissure/doc/conf.py.in @@ -0,0 +1,179 @@ +# -*- coding: utf-8 -*- +# +# Yams PlugIn documentation build configuration file, created by +# sphinx-quickstart on Wed Sep 14 11:40:32 2011. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# The contents of this file are pickled, so don't put values in the namespace +# that aren't pickleable (module imports are okay, they're removed automatically). +# +# All configuration values have a default value; values that are commented out +# serve to show the default value. + +import sys, os + +# 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 +# absolute, like shown here. +#sys.path.append(os.path.abspath('some/directory')) + +# General configuration +# --------------------- + +# 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'] + +# Add any paths that contain templates here, relative to this directory. +#templates_path = ['.templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General substitutions. +project = 'Plug-in blocFissure' +copyright = '2010-2016 EDF R&D' + +# The default replacements for |version| and |release|, also used in various +# other places throughout the built documents. +# +# The short X.Y version. +version = '@SALOMESMESH_VERSION@' +# The full version, including alpha/beta/rc tags. +release = '@SALOMESMESH_VERSION@' + +# 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 documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directories, that shouldn't be searched +# for source files. +#exclude_dirs = [] + +# 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' + + +# Options for HTML output +# ----------------------- + +# The style sheet to use for HTML and HTML Help pages. A file of that name +# must exist either in Sphinx' static/ path, or in one of the custom paths +# given in html_static_path. +html_style = 'default' + +# The name for this set of Sphinx documents. If None, it defaults to +# " v 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 (within the static path) 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 = '%b %d, %Y' + +# 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_use_modindex = 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, the reST sources are included in the HTML build as _sources/. +#html_copy_source = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'blocFissure_doc' + + +# Options for LaTeX output +# ------------------------ + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, document class [howto/manual]). +latex_documents = [ + ('index', 'blocFissure.tex', 'Documentation Plug-in blocFissure', + 'EDF', '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 + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_use_modindex = True diff --git a/src/Tools/blocFissure/doc/index.rst b/src/Tools/blocFissure/doc/index.rst new file mode 100644 index 000000000..4005e6b10 --- /dev/null +++ b/src/Tools/blocFissure/doc/index.rst @@ -0,0 +1,39 @@ +.. + Copyright (C) 2015-2016 EDF + + This file is part of SALOME HYDRO module. + + SALOME HYDRO module is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + SALOME HYDRO module is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with SALOME HYDRO module. If not, see . + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Documentation du plugin blocFissure +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +Le plugin blocFissure traite l'insertion de fissure dans un maillage sain. + +################### +Outil métier coudes +################### + +Cet outil génère des maillages de tuyaux coudés, avec des fissures de différents types, au niveau du coude. +Cet outil traite un cas particulier de l'outil général d'insertion de fissure dans un maillage sain. + +########################################## +Insertion de fissure dans un maillage sain +########################################## + +Partant d'un maillage sain et d'une face de fissure décrite en CAO, l'outil modifie le maillage sain, +en introduisant un maillage de la fissure, sous la forme d'un tore rayonnant le long de la ligne de fond de fissure. -- 2.30.2