diff --git a/docs/conf.py b/docs/conf.py index e935d46..436f7bc 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,26 +6,26 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autosectionlabel', - 'sphinx.ext.autodoc', - 'sphinx.ext.autodoc.typehints', - 'sphinx.ext.napoleon', - 'sphinx.ext.doctest', - 'sphinx.ext.intersphinx', - 'sphinx.ext.autosummary', - 'sphinx.ext.todo', - 'sphinx.ext.mathjax', - 'sphinx.ext.coverage', - 'sphinx.ext.imgmath', - 'sphinx.ext.ifconfig', - 'sphinx.ext.viewcode', - 'sphinx_new_tab_link', - 'myst_nb', + "sphinx.ext.autosectionlabel", + "sphinx.ext.autodoc", + "sphinx.ext.autodoc.typehints", + "sphinx.ext.napoleon", + "sphinx.ext.doctest", + "sphinx.ext.intersphinx", + "sphinx.ext.autosummary", + "sphinx.ext.todo", + "sphinx.ext.mathjax", + "sphinx.ext.coverage", + "sphinx.ext.imgmath", + "sphinx.ext.ifconfig", + "sphinx.ext.viewcode", + "sphinx_new_tab_link", + "myst_nb", ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # If true, the current module name will be prepended to all description # unit titles (such as .. function::). @@ -35,11 +35,13 @@ ## Include Python objects as they appear in source files ## Default: alphabetically ('alphabetical') -autodoc_member_order = 'bysource' +autodoc_member_order = "bysource" ## Default flags used by autodoc directives -autodoc_default_options = {'members': True, - 'show-inheritance': True, - 'undoc-members': True} +autodoc_default_options = { + "members": True, + "show-inheritance": True, + "undoc-members": True, +} ## Generate autodoc stubs with summaries from code autosummary_generate = True @@ -47,13 +49,13 @@ # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = 'acore' +project = "acore" copyright = "2023, Multi-omics Network Analytics Group" author = "Multi-omics Network Analytics Group" @@ -71,17 +73,21 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = 'en' +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', - "jupyter_execute", - "conf.py",] +exclude_patterns = [ + "_build", + "Thumbs.db", + ".DS_Store", + "jupyter_execute", + "conf.py", +] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -130,8 +136,8 @@ # https://github.com/executablebooks/MyST-NB/blob/master/docs/conf.py # html_title = "" html_theme = "sphinx_book_theme" -# html_logo = "_static/logo-wide.svg" -# html_favicon = "_static/logo-square.svg" +# html_logo = "logo/analytics_512px.png" +html_favicon = "logo/analytics_64px.png" html_theme_options = { "github_url": "https://github.com/Multiomics-Analytics-Group/acore/", "repository_url": "https://github.com/Multiomics-Analytics-Group/acore/", @@ -158,7 +164,7 @@ # -- Options for HTMLHelp output --------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'acoredoc' +htmlhelp_basename = "acoredoc" # -- Options for LaTeX output ------------------------------------------ @@ -167,15 +173,12 @@ # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. # # 'preamble': '', - # Latex figure (float) alignment # # 'figure_align': 'htbp', @@ -185,9 +188,13 @@ # (source start file, target name, title, author, documentclass # [howto, manual, or own class]). latex_documents = [ - (master_doc, 'acore.tex', - 'Analytics Core Documentation', - 'Multi-omics Network Analytics Group', 'manual'), + ( + master_doc, + "acore.tex", + "Analytics Core Documentation", + "Multi-omics Network Analytics Group", + "manual", + ), ] @@ -195,11 +202,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'acore', - 'Analytics Core Documentation', - [author], 1) -] +man_pages = [(master_doc, "acore", "Analytics Core Documentation", [author], 1)] # -- Options for Texinfo output ---------------------------------------- @@ -208,12 +211,15 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'acore', - 'Analytics Core Documentation', - author, - 'acore', - 'Oneline description of project.', - 'Miscellaneous'), + ( + master_doc, + "acore", + "Analytics Core Documentation", + author, + "acore", + "Oneline description of project.", + "Miscellaneous", + ), ] diff --git a/docs/logo/analytics_512px.png b/docs/logo/analytics_512px.png new file mode 100644 index 0000000..6d46eed Binary files /dev/null and b/docs/logo/analytics_512px.png differ diff --git a/docs/logo/analytics_64px.png b/docs/logo/analytics_64px.png new file mode 100644 index 0000000..4907c0a Binary files /dev/null and b/docs/logo/analytics_64px.png differ