X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/85b6c08c26f9da9041c315d3e9cbd4f20f8db9ff..0a6556cf9aa3e733965b6a18574efd63b54caa0d:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index 952ca49c80..b84834c4f1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -32,11 +32,11 @@ if read_the_docs_build: # -- Project information ----------------------------------------------------- project = u'SimGrid' -copyright = u'2002-2021, The SimGrid Team' +copyright = u'2002-2022, The SimGrid Team' author = u'The SimGrid Team' # The short X.Y version -version = u'3.28.1' +version = u'3.32.1' # -- General configuration --------------------------------------------------- @@ -54,6 +54,7 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.autosummary', 'sphinx_tabs.tabs', + 'sphinx_copybutton', 'javasphinx', 'showfile', ] @@ -64,6 +65,10 @@ todo_include_todos = True breathe_projects = {'simgrid': '../build/xml'} breathe_default_project = "simgrid" +# 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 = [ @@ -92,13 +97,19 @@ nitpick_ignore = [ ('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'), @@ -118,13 +129,13 @@ nitpick_ignore = [ ('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'), @@ -149,7 +160,6 @@ nitpick_ignore = [ ('cpp:identifier', 'xbt::signal'), ('cpp:identifier', 'xbt::signal'), ('cpp:identifier', 'xbt::signal'), - ('cpp:identifier', 'xbt::string'), ] # For cross-ref generation