{"id":28573393,"url":"https://github.com/pennylaneai/pennylane-sphinx-theme","last_synced_at":"2026-04-06T00:03:14.615Z","repository":{"id":61594303,"uuid":"540225760","full_name":"PennyLaneAI/pennylane-sphinx-theme","owner":"PennyLaneAI","description":"Sphinx theme for PennyLaneAI repositories","archived":false,"fork":false,"pushed_at":"2025-04-23T20:32:00.000Z","size":665,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-23T21:32:29.191Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.pennylane.ai/projects/sphinx-theme","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PennyLaneAI.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-09-23T00:55:48.000Z","updated_at":"2025-04-23T20:31:53.000Z","dependencies_parsed_at":"2023-10-14T18:16:25.968Z","dependency_job_id":"9434be7e-872f-4a28-9b95-628f798473f7","html_url":"https://github.com/PennyLaneAI/pennylane-sphinx-theme","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PennyLaneAI%2Fpennylane-sphinx-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PennyLaneAI%2Fpennylane-sphinx-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PennyLaneAI%2Fpennylane-sphinx-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PennyLaneAI%2Fpennylane-sphinx-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PennyLaneAI","download_url":"https://codeload.github.com/PennyLaneAI/pennylane-sphinx-theme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PennyLaneAI%2Fpennylane-sphinx-theme/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259152773,"owners_count":22813223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-10T21:17:43.216Z","updated_at":"2026-04-06T00:03:14.570Z","avatar_url":"https://github.com/PennyLaneAI.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"PennyLane Sphinx Theme\n######################\n\n.. header-start-inclusion-marker-do-not-remove\n\nThe **PennyLane Sphinx Theme** is a Sphinx theme used for open-source PennyLane\nsoftware projects hosted on https://pennylane.ai. It extends the Xanadu Sphinx Theme\nwith PennyLane-specific default settings and configurations.\n\nTo update the PennyLane navigation bar (navbar) and footer, please see the files\n``pennylane_sphinx_theme/footer.py`` and ``pennylane_sphinx_theme/navbar.py``.\n\nFor more details, please see the\n`Xanadu Sphinx Theme documentation \u003chttps://xanadu-sphinx-theme.readthedocs.io/en/latest/\u003e`__.\n\n.. header-end-inclusion-marker-do-not-remove\n\n\nInstallation\n============\n\n.. installation-start-inclusion-marker-do-not-remove\n\nThe PennyLane Sphinx Theme requires Python 3.7 or later. The latest version of the\ntheme can be installed directly using ``pip``:\n\n.. code-block:: bash\n\n    pip install pennylane-sphinx-theme\n\n\n.. installation-end-inclusion-marker-do-not-remove\n\n\nGetting Started\n===============\n\n.. getting-started-start-inclusion-marker-do-not-remove\n\nOnce installed, simply add or modify the following variables of your Sphinx\n``conf.py`` configuration file to start using the PennyLane Sphinx Theme:\n\n.. code-block:: python\n\n    from pennylane_sphinx_theme import templates_dir\n    templates_path = [templates_dir()]\n\n    html_theme = \"pennylane\"\n\n    html_theme_options = {\n        \"navbar_name\": \"Example Project\"\n    }\n\n.. getting-started-end-inclusion-marker-do-not-remove\n\nConfiguration\n=============\n\n.. configuration-start-inclusion-marker-do-not-remove\n\nThe PennyLane Sphinx Theme supports the same configration options as\nthe Xanadu Sphinx Theme. For more details, please see the\n`Xanadu Sphinx Theme documentation \u003chttps://xanadu-sphinx-theme.readthedocs.io/en/latest/\u003e`__.\n\n.. configuration-end-inclusion-marker-do-not-remove\n\nDirectives\n==========\n\n.. directives-start-inclusion-marker-do-not-remove\n\nThe PennyLane Sphinx Theme provides various directives.\n\nFor more details, please see the\n`Xanadu Sphinx Theme documentation \u003chttps://xanadu-sphinx-theme.readthedocs.io/en/latest/\u003e`__.\n\n\n.. directives-end-inclusion-marker-do-not-remove\n\nRelease\n============\n\n.. release-start-inclusion-marker-do-not-remove\n\n1. Make a PR with the desired changes to the PST (pennylane-sphinx-theme).\n    - Don’t forget to update the ``CHANGELOG``!\n    - Merge in your PR once it is approved.\n2. Prepare the PST for release.\n    - Once PR is merged it will trigger the `Pre-Release Version Bump \u003chttps://github.com/PennyLaneAI/pennylane-sphinx-theme/actions/workflows/pre_release_version_bump.yml\u003e`__ workflow.\n    - The workflow will open a PR ``Pre-release version bump to X.Y.Z``. Adjust the release version number as necessary.\n    - Merge in the ``Pre-release version bump to X.Y.Z`` PR.\n3. Release a new version of the PST.\n    - Once ``Pre-release version bump to X.Y.Z`` PR is merged in it will automatically create new release of PST.\n    - It will also run the `Post-Release Version Bump \u003chttps://github.com/PennyLaneAI/pennylane-sphinx-theme/actions/workflows/post_release_version_bump.yml\u003e`__ workflow. \n    - The workflow will open a ``Post-release version bump to X.Y.Z`` PR that can be merged in ``master`` to increment the version for next release.\n\n.. release-end-inclusion-marker-do-not-remove\n\nSupport\n=======\n\n.. support-start-inclusion-marker-do-not-remove\n\n- **Source Code:** https://github.com/XanaduAI/pennylane-sphinx-theme\n- **Issue Tracker:** https://github.com/XanaduAI/pennylane-sphinx-theme/issues\n\nIf you are having issues, please let us know by posting the issue on our Github\nissue tracker.\n\n.. support-end-inclusion-marker-do-not-remove\n\nLicense\n=======\n\n.. license-start-inclusion-marker-do-not-remove\n\nThe PennyLane Sphinx Theme is **free** and **open source**, released under the\n`Apache License, Version 2.0 \u003chttps://www.apache.org/licenses/LICENSE-2.0\u003e`_.\n\n.. license-end-inclusion-marker-do-not-remove\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpennylaneai%2Fpennylane-sphinx-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpennylaneai%2Fpennylane-sphinx-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpennylaneai%2Fpennylane-sphinx-theme/lists"}