X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/db0a920c7af44944ca27c2edfd06232d3d74a9d3..472cf2ae0b7d14830217c5a0024c5c27c2336af4:/docs/source/conf.py?ds=sidebyside diff --git a/docs/source/conf.py b/docs/source/conf.py index b57d1f3837..03d7271983 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,33 +12,31 @@ # 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, subprocess +import os +import subprocess -# Search for our extensions too +# Search for our extensions too import sys sys.path.append(os.path.abspath('_ext')) # -- Run doxygen on readthedocs.org ------------------------------------------ -import subprocess, os read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' if read_the_docs_build: - subprocess.call('cd source; doxygen', shell=True) - subprocess.call('javasphinx-apidoc --force -o source/java/ ../src/bindings/java/org/simgrid/msg', shell=True) - subprocess.call('rm source/java/packages.rst', shell=True) + subprocess.call('pwd', shell=True) # should be in docs/source + subprocess.call('doxygen', shell=True) + subprocess.call('javasphinx-apidoc --force -o java/ ../../src/bindings/java/org/simgrid/msg', shell=True) + subprocess.call('rm java/packages.rst', shell=True) # -- Project information ----------------------------------------------------- project = u'SimGrid' -copyright = u'2002-2018, The SimGrid Team' +copyright = u'2002-2022, 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.31.1' # -- General configuration --------------------------------------------------- @@ -52,37 +50,125 @@ release = u'3.21' extensions = [ 'sphinx.ext.todo', 'breathe', -# 'exhale', - 'hidden_code_block', + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.autosummary', + 'sphinx_tabs.tabs', + 'sphinx_copybutton', 'javasphinx', + 'showfile', ] todo_include_todos = True -breathe_projects = { 'simgrid': '../build/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, - "exhaleExecutesDoxygen": False, - # "exhaleUseDoxyfile": True, -} - +# 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', 'sg_msg_Comm'), + ('cpp:identifier', 'sg_msg_Task'), + ('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', 'simgrid::xbt::string'), + ('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'), + ('cpp:identifier', 'xbt::string'), +] # 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'] @@ -118,7 +204,7 @@ html_theme = 'sphinx_rtd_theme' # documentation. # html_theme_options = { - 'navigation_depth' : 4, + 'navigation_depth': 4, 'sticky_navigation': True, 'display_version': True, 'includehidden': True, @@ -127,7 +213,7 @@ html_theme_options = { # 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. @@ -142,16 +228,21 @@ html_theme_options = { # -- 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 + "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