{"library":"sphinx-immaterial","title":"Sphinx Immaterial Theme","type":"library","description":"Sphinx-Immaterial is an adaptation of the popular mkdocs-material theme for the Sphinx documentation system. It is actively maintained to stay up to date with the upstream mkdocs-material repository, incorporating HTML templates, JavaScript, and styles with mostly minor modifications. The current version is 0.13.9, with frequent minor releases as seen in the GitHub changelog, often driven by upstream `mkdocs-material` updates or Sphinx compatibility fixes.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install sphinx-immaterial"],"cli":null},"imports":["extensions = [\n    # ... other extensions\n    'sphinx_immaterial'\n]","html_theme = 'sphinx_immaterial'"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/jbms/sphinx-immaterial","docs":"https://jbms.github.io/sphinx-immaterial","changelog":null,"pypi":"https://pypi.org/project/sphinx-immaterial/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"import os\nimport sys\n\n# Minimal conf.py\nproject = 'My Project'\ncopyright = '2026, Your Name'\nauthor = 'Your Name'\nrelease = '0.1'\n\nextensions = [\n    'sphinx_immaterial',\n    'sphinx.ext.autodoc', # Example standard extension\n]\n\nhtml_theme = 'sphinx_immaterial'\nhtml_theme_options = {\n    'icon': {\n        'repo': 'fontawesome/brands/github'\n    },\n    'site_url': 'https://example.com/docs/'\n}\n\n# Example index.rst (or index.md if markdown is enabled)\n# You would typically generate this with sphinx-quickstart first.\n# Replace with content of docs/index.rst or equivalent.\n# This part is illustrative, not executed Python code.\n# Example: docs/index.rst\n# My Project\n# ===========\n#\n# Welcome to my project's documentation!\n#\n# .. toctree::\n#    :maxdepth: 2\n#    :caption: Contents:\n#\n#    module1\n#    module2","lang":"python","description":"To quickly set up `sphinx-immaterial`, first initialize a Sphinx project using `sphinx-quickstart`. Then, modify the `conf.py` file to include `sphinx_immaterial` in your `extensions` list and set `html_theme = 'sphinx_immaterial'`. You can further customize the theme using `html_theme_options` in `conf.py`.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}