X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FPythonAPI%2Fdoc%2Fsource%2Fconf.py;h=a16b5f3eb669bda38bb1ab4434b85541ff9b6d99;hb=749e980caeebfe4d16441703b7028dbbb1f1d91a;hp=b1c4499dbaaef32d8ae2e7cced6ed878459c6891;hpb=e8749ccc51bd96a90fdf01025a78fb6d0271d637;p=modules%2Fshaper.git diff --git a/src/PythonAPI/doc/source/conf.py b/src/PythonAPI/doc/source/conf.py index b1c4499db..a16b5f3eb 100644 --- a/src/PythonAPI/doc/source/conf.py +++ b/src/PythonAPI/doc/source/conf.py @@ -1,5 +1,3 @@ -# -*- coding: utf-8 -*- -# # Shaper python API documentation build configuration file, created by # sphinx-quickstart on Thu Oct 15 11:55:42 2015. # @@ -36,6 +34,8 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', + 'sphinx.ext.napoleon', + 'sphinx.ext.autosummary', ] # Add any paths that contain templates here, relative to this directory. @@ -51,8 +51,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Shaper python API' -copyright = u'2015, Renaud Nédélec' +project = 'Shaper python API' +copyright = '2014-2019 CEA/DEN, EDF R&D' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -204,8 +204,8 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'ShaperpythonAPI.tex', u'Shaper python API Documentation', - u'Renaud Nédélec', 'manual'), + ('index', 'ShaperpythonAPI.tex', 'Shaper python API Documentation', + 'Renaud Nédélec', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -234,8 +234,8 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'shaperpythonapi', u'Shaper python API Documentation', - [u'Renaud Nédélec'], 1) + ('index', 'shaperpythonapi', 'Shaper python API Documentation', + ['Renaud Nédélec'], 1) ] # If true, show URL addresses after external links. @@ -248,8 +248,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'ShaperpythonAPI', u'Shaper python API Documentation', - u'Renaud Nédélec', 'ShaperpythonAPI', 'One line description of project.', + ('index', 'ShaperpythonAPI', 'Shaper python API Documentation', + 'Renaud Nédélec', 'ShaperpythonAPI', 'One line description of project.', 'Miscellaneous'), ] @@ -264,3 +264,6 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + +autodoc_member_order = 'bysource' +