X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/73b559c7c9341d9d98fc8f0523be23ba9d676fa6..39c935d6d5ee86d153f6f7e6a10d723ae7c57f6f:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index 70f5238758..9386f7b2a6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,22 +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 -# 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) + 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'2018, The SimGrid Team' +copyright = u'2002-2020, 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.26.1' # -- General configuration --------------------------------------------------- @@ -40,59 +49,81 @@ 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.intersphinx', + 'sphinx.ext.autosummary', + 'sphinx_tabs.tabs', + 'javasphinx', + 'showfile', + 'autodoxy', ] 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 autodoxy extension +doxygen_xml = os.path.join(os.path.dirname(__file__), "..", "build", "xml") +autodoxy_requalified_identifiers = [ # The first element will be substituted into the second one if it's starting an element or preceded by a space + ("Activity", "simgrid::s4u::Activity"), + ("Actor", "simgrid::s4u::Actor"), + ("ActorPtr", "simgrid::s4u::ActorPtr"), + ("Barrier", "simgrid::s4u::Barrier"), + ("BarrierPtr", "simgrid::s4u::BarrierPtr"), + ("Comm", "simgrid::s4u::Comm"), + ("CommPtr", "simgrid::s4u::CommPtr"), + ("ConditionVariable", "simgrid::s4u::ConditionVariable"), + ("ConditionVariablePtr", "simgrid::s4u::ConditionVariablePtr"), + ("Disk", "simgrid::s4u::Disk"), + ("Exec", "simgrid::s4u::Exec"), + ("ExecPtr", "simgrid::s4u::ExecPtr"), + ("Host", "simgrid::s4u::Host"), + ("s4u::Host", "simgrid::s4u::Host"), + ("Engine", "simgrid::s4u::Engine"), + ("Io", "simgrid::s4u::Io"), + ("Link", "simgrid::s4u::Link"), + ("Mailbox", "simgrid::s4u::Mailbox"), + ("Mutex", "simgrid::s4u::Mutex"), + ("s4u::Mutex", "simgrid::s4u::Mutex"), + ("s4u::MutexPtr", "simgrid::s4u::MutexPtr"), + ("NetZone", "simgrid::s4u::NetZone"), + ("Semaphore", "simgrid::s4u::Semaphore"), + ("VirtualMachine", "simgrid::s4u::VirtualMachine"), + ] + +# 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', 'kernel'), + ('cpp:identifier', 'kernel::activity'), + ('cpp:identifier', 'kernel::profile'), + ('cpp:identifier', 'kernel::resource'), + ('cpp:identifier', 'kernel::routing'), + ('cpp:identifier', 'simgrid'), + ('cpp:identifier', 'simgrid::s4u'), + ('cpp:identifier', 'this_actor'), + ('cpp:identifier', 's4u'), + ('cpp:identifier', 'size_t'), + ('cpp:identifier', 'uint64_t'), + ('cpp:identifier', 'xbt'), + ('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'] @@ -116,7 +147,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 @@ -128,12 +158,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. @@ -148,15 +183,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