X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d43e84e981024537b56f15f7dcc937b0202cad2b..34b1612aaf4fb4375dc39f42941027e56b80aafa:/docs/source/conf.py?ds=sidebyside diff --git a/docs/source/conf.py b/docs/source/conf.py index 8fd2797e59..1c8d99c369 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,22 +12,29 @@ # 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. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import subprocess +# Search for our extensions too +import sys +sys.path.append(os.path.abspath('_ext')) + +# -- Run doxygen on readthedocs.org ------------------------------------------ + +read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' + +if read_the_docs_build: + subprocess.call('pwd', shell=True) # should be in docs/source + subprocess.call('doxygen', shell=True) # -- Project information ----------------------------------------------------- project = u'SimGrid' -copyright = u'2018, The SimGrid Team' +copyright = u'2002-2023, The SimGrid Team' author = u'The SimGrid Team' # The short X.Y version -version = u'3.21' -# The full version, including alpha/beta/rc tags -release = u'3.21' - +version = u'3.32.1' # -- General configuration --------------------------------------------------- @@ -40,58 +47,122 @@ release = u'3.21' # ones. extensions = [ 'sphinx.ext.todo', -# 'sphinx.ext.coverage', - 'sphinx.ext.mathjax', -# 'sphinx.ext.ifconfig', 'breathe', - 'exhale', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.intersphinx', + 'sphinx.ext.mathjax', + 'sphinx_tabs.tabs', + 'sphinx_copybutton', + 'showfile', ] todo_include_todos = True -breathe_projects = { 'simgrid': '../build/doxy/xml' } +# Setup the breath extension +breathe_projects = {'simgrid': '../build/xml'} breathe_default_project = "simgrid" -# Setup the exhale extension -exhale_args = { - # These arguments are required - "containmentFolder": "./api", - "rootFileName": "library_root.rst", - "rootFileTitle": "SimGrid Full API", - "doxygenStripFromPath": "..", - # Suggested optional arguments - "createTreeView": True, - # TIP: if using the sphinx-bootstrap-theme, you need - # "treeViewIsBootstrap": True, - "exhaleExecutesDoxygen": True, - "exhaleDoxygenStdin": """ - INPUT = ../../include/simgrid/s4u - GENERATE_XML = YES - PREDEFINED += \ - __cplusplus \ - DOXYGEN \ - XBT_PUBLIC= \ - XBT_EXPORT_NO_IMPORT= \ - XBT_IMPORT_NO_EXPORT= \ - XBT_PUBLIC_DATA=extern \ - XBT_PUBLIC= \ - XBT_INLINE= \ - XBT_ALWAYS_INLINE= \ - XBT_PRIVATE= \ - XBT_ATTRIB_NORETURN= \ - XBT_ATTRIB_UNUSED= \ - XBT_ATTRIB_DEPRECATED_v322(m)= \ - XBT_ATTRIB_DEPRECATED_v323(m)= \ - XBT_ATTRIB_DEPRECATED_v324(m)= - """ -} +# Setup the copybutton extension +copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " +copybutton_prompt_is_regexp = True + +# Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found +nitpicky = True +nitpick_ignore = [ + ('cpp:identifier', 'boost'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'kernel'), + ('cpp:identifier', 'kernel::activity'), + ('cpp:identifier', 'kernel::activity::ActivityImplPtr'), + ('cpp:identifier', 'kernel::activity::CommImpl'), + ('cpp:identifier', 'kernel::activity::CommImplPtr'), + ('cpp:identifier', 'kernel::actor'), + ('cpp:identifier', 'kernel::actor::ActorCodeFactory'), + ('cpp:identifier', 'kernel::actor::ActorImpl'), + ('cpp:identifier', 'kernel::profile'), + ('cpp:identifier', 'kernel::profile::Profile'), + ('cpp:identifier', 'kernel::resource'), + ('cpp:identifier', 'kernel::resource::Action'), + ('cpp:identifier', 'kernel::resource::Action::State'), + ('cpp:identifier', 'kernel::resource::LinkImpl'), + ('cpp:identifier', 'kernel::resource::NetworkAction'), + ('cpp:identifier', 'kernel::resource::SplitDuplexLinkImpl'), + ('cpp:identifier', 'kernel::resource::StandardLinkImpl'), + ('cpp:identifier', 'kernel::routing'), + ('cpp:identifier', 'kernel::routing::NetPoint'), + ('cpp:identifier', 'ns3'), + ('cpp:identifier', 'ns3::Ptr'), + ('cpp:identifier', 'ns3::Node'), + ('cpp:identifier', 's4u'), + ('cpp:identifier', 's4u_Actor'), + ('cpp:identifier', 's4u_Barrier'), + ('cpp:identifier', 's4u_Comm'), + ('cpp:identifier', 's4u_ConditionVariable'), + ('cpp:identifier', 's4u_Disk'), + ('cpp:identifier', 's4u_Exec'), + ('cpp:identifier', 's4u_File'), + ('cpp:identifier', 's4u_Host'), + ('cpp:identifier', 's4u_Link'), + ('cpp:identifier', 's4u_Mailbox'), + ('cpp:identifier', 's4u_Mutex'), + ('cpp:identifier', 's4u_NetZone'), + ('cpp:identifier', 's4u_Semaphore'), + ('cpp:identifier', 's4u_VM'), + ('cpp:identifier', 's4u_VirtualMachine'), + ('cpp:identifier', 'simgrid'), + ('cpp:identifier', 'simgrid::s4u'), + ('cpp:identifier', 'simgrid::s4u::Activity_T'), + ('cpp:identifier', 'simgrid::s4u::Activity_T'), + ('cpp:identifier', 'simgrid::s4u::Activity_T'), + ('cpp:identifier', 'simgrid::s4u::this_actor'), + ('cpp:identifier', 'simgrid::xbt'), + ('cpp:identifier', 'size_t'), + ('cpp:identifier', 'ssize_t'), + ('cpp:identifier', 'this_actor'), + ('cpp:identifier', 'uint64_t'), + ('cpp:identifier', 'xbt'), + ('cpp:identifier', 'xbt_dynar_s'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), +] # For cross-ref generation primary_domain = 'cpp' - # Add any paths that contain templates here, relative to this directory. -# templates_path = ['_templates'] +templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: ['.rst', '.md'] @@ -105,7 +176,7 @@ master_doc = 'index' # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -115,7 +186,6 @@ exclude_patterns = [] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' - # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -127,12 +197,17 @@ html_theme = 'sphinx_rtd_theme' # further. For a list of options available for each theme, see the # documentation. # -# html_theme_options = {} +html_theme_options = { + 'navigation_depth': 4, + 'sticky_navigation': True, + 'display_version': True, + 'includehidden': True, +} # 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'] +html_static_path = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -147,15 +222,21 @@ html_theme = 'sphinx_rtd_theme' # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'SimGrid-doc' +htmlhelp_basename = 'simgrid-doc' # -- Options for GitLab integration ------------------------------------------ html_context = { - "display_gitlab": True, # Integrate Gitlab - "gitlab_host": "framagit.org", + "display_gitlab": True, # Integrate Gitlab + "gitlab_host": "framagit.org", "gitlab_user": "simgrid", "gitlab_repo": "simgrid", - "gitlab_version": "master", # Version - "conf_py_path": "/docs/source/", # Path in the checkout to the docs root + "gitlab_version": "master", # Version + "conf_py_path": "/docs/source/", # Path in the checkout to the docs root } + +html_css_files = [ + 'css/custom.css', +] + +# -- Other options