conf.py 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. import guzzle_sphinx_theme
  2. # Configuration file for the Sphinx documentation builder.
  3. #
  4. # For the full list of built-in configuration values, see the documentation:
  5. # https://www.sphinx-doc.org/en/master/usage/configuration.html
  6. # -- Project information -----------------------------------------------------
  7. # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
  8. project = 'm2met2'
  9. copyright = '2023, Speech Lab, Alibaba Group; ASLP Group, Northwestern Polytechnical University'
  10. author = 'Speech Lab, Alibaba Group; Audio, Speech and Language Processing Group, Northwestern Polytechnical University'
  11. # -- General configuration ---------------------------------------------------
  12. # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
  13. extensions = [
  14. 'myst_parser',
  15. 'guzzle_sphinx_theme'
  16. ]
  17. myst_enable_extensions = [
  18. "colon_fence",
  19. "deflist",
  20. "dollarmath",
  21. "html_image",
  22. ]
  23. myst_heading_anchors = 2
  24. myst_highlight_code_blocks=True
  25. myst_update_mathjax=False
  26. templates_path = ['_templates']
  27. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  28. # -- Options for HTML output -------------------------------------------------
  29. # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
  30. html_sidebars = {
  31. '**': ['logo-text.html',
  32. 'searchbox.html',
  33. 'globaltoc.html']
  34. }
  35. html_theme_path = guzzle_sphinx_theme.html_theme_path()
  36. html_theme = 'guzzle_sphinx_theme'
  37. html_static_path = ['_static']
  38. # html_sidebars = {'**': ['fulltoc.html', 'searchbox.html', 'layout.html']}
  39. html_theme_options = {
  40. "globaltoc_collapse": False,
  41. "globaltoc_includehidden": True,
  42. }