X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/12789d134b3ae0061164cf1658bfdd42abd27574..2516bc5bf0760874f7ccd2b878657e6ab442649d:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index e8de0fb671..fed868fbd0 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-2020, The SimGrid Team' +copyright = u'2002-2021, The SimGrid Team' author = u'The SimGrid Team' # The short X.Y version -version = u'3.25.1' +version = u'3.28.1' # -- General configuration --------------------------------------------------- @@ -56,7 +56,6 @@ extensions = [ 'sphinx_tabs.tabs', 'javasphinx', 'showfile', - 'autodoxy', ] todo_include_todos = True @@ -65,8 +64,92 @@ todo_include_todos = True breathe_projects = {'simgrid': '../build/xml'} breathe_default_project = "simgrid" -# Setup the autodoxy extension -doxygen_xml = os.path.join(os.path.dirname(__file__), "..", "build", "xml") +# 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::routing'), + ('cpp:identifier', 'kernel::routing::NetPoint'), + ('cpp:identifier', 's4u'), + ('cpp:identifier', 's4u_Actor'), + ('cpp:identifier', 's4u_Barrier'), + ('cpp:identifier', 's4u_Comm'), + ('cpp:identifier', 's4u_ConditionVariable'), + ('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::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' @@ -132,7 +215,7 @@ html_static_path = ['_static'] # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'SimGrid-doc' +htmlhelp_basename = 'simgrid-doc' # -- Options for GitLab integration ------------------------------------------ @@ -150,5 +233,3 @@ html_css_files = [ ] # -- Other options - -nitpicky = True # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found