conf.py 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. # Configuration file for the Sphinx documentation builder.
  2. #
  3. # This file only contains a selection of the most common options. For a full
  4. # list see the documentation:
  5. # https://www.sphinx-doc.org/en/master/usage/configuration.html
  6. # -- Path setup --------------------------------------------------------------
  7. # If extensions (or modules to document with autodoc) are in another directory,
  8. # add these directories to sys.path here. If the directory is relative to the
  9. # documentation root, use os.path.abspath to make it absolute, like shown here.
  10. #
  11. # import os
  12. # import sys
  13. # sys.path.insert(0, os.path.abspath('.'))
  14. import datetime
  15. # -- Project information -----------------------------------------------------
  16. project = 'Bitbake'
  17. copyright = '2004-%s, Richard Purdie, Chris Larson, and Phil Blundell' \
  18. % datetime.datetime.now().year
  19. author = 'Richard Purdie, Chris Larson, and Phil Blundell'
  20. # -- General configuration ---------------------------------------------------
  21. # Add any Sphinx extension module names here, as strings. They can be
  22. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  23. # ones.
  24. extensions = [
  25. 'sphinx.ext.autosectionlabel',
  26. ]
  27. autosectionlabel_prefix_document = True
  28. # Add any paths that contain templates here, relative to this directory.
  29. templates_path = ['_templates']
  30. # List of patterns, relative to source directory, that match files and
  31. # directories to ignore when looking for source files.
  32. # This pattern also affects html_static_path and html_extra_path.
  33. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  34. # master document name. The default changed from contents to index. so better
  35. # set it ourselves.
  36. master_doc = 'index'
  37. # create substitution for project configuration variables
  38. rst_prolog = """
  39. .. |project_name| replace:: %s
  40. .. |copyright| replace:: %s
  41. .. |author| replace:: %s
  42. """ % (project, copyright, author)
  43. # -- Options for HTML output -------------------------------------------------
  44. # The theme to use for HTML and HTML Help pages. See the documentation for
  45. # a list of builtin themes.
  46. #
  47. html_theme = 'sphinx_rtd_theme'
  48. # Add any paths that contain custom static files (such as style sheets) here,
  49. # relative to this directory. They are copied after the builtin static files,
  50. # so a file named "default.css" will overwrite the builtin "default.css".
  51. html_static_path = ['sphinx-static']
  52. # Add customm CSS and JS files
  53. html_css_files = ['theme_overrides.css']
  54. # Hide 'Created using Sphinx' text
  55. html_show_sphinx = False
  56. # Add 'Last updated' on each page
  57. html_last_updated_fmt = '%b %d, %Y'
  58. # Remove the trailing 'dot' in section numbers
  59. html_secnumber_suffix = " "