{"id":29017861,"url":"https://github.com/cakephp/sphinxtheme","last_synced_at":"2026-02-25T02:32:56.182Z","repository":{"id":40831075,"uuid":"115166343","full_name":"cakephp/sphinxtheme","owner":"cakephp","description":"Sphinx theme and common configuration for CakePHP documentation projects.","archived":false,"fork":false,"pushed_at":"2025-03-12T02:57:24.000Z","size":1764,"stargazers_count":11,"open_issues_count":0,"forks_count":11,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-06-25T23:07:17.824Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cakephp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2017-12-23T03:03:03.000Z","updated_at":"2025-06-23T04:35:10.000Z","dependencies_parsed_at":"2024-05-21T04:31:31.917Z","dependency_job_id":"c4d2c2f0-7feb-424d-98e9-f018c1114a4a","html_url":"https://github.com/cakephp/sphinxtheme","commit_stats":null,"previous_names":[],"tags_count":64,"template":false,"template_full_name":null,"purl":"pkg:github/cakephp/sphinxtheme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fsphinxtheme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fsphinxtheme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fsphinxtheme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fsphinxtheme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cakephp","download_url":"https://codeload.github.com/cakephp/sphinxtheme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cakephp%2Fsphinxtheme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29809086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-24T22:43:48.403Z","status":"online","status_checked_at":"2026-02-25T02:00:07.329Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-25T23:07:16.760Z","updated_at":"2026-02-25T02:32:56.142Z","avatar_url":"https://github.com/cakephp.png","language":"CSS","readme":"# CakePHP Sphinx Theme\n\n[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.txt)\n\nThis is the sphinx theme used for the official CakePHP documentation projects.\nIt helps create HTML, PDF, and EPUB formats consistently across all the CakePHP\nprojects and branches.\n\nYou can see this theme in action at https://book.cakephp.org\n\nFor the actual CakePHP documentation see\n[cakephp/docs](https://github.com/cakephp/docs).\n\n\n## Developing/Testing changes to this theme\n\nWorking with this theme requires you to have sphinx installed in a virtualenv.\nLets assume you want to test some theme changes out with cakephp/docs.\n\n```bash\n# Clone the docs\ngit clone git@github.com:cakephp/docs cake_docs\ncd cake_docs\n\n# Create a virtualenv\nvirtualenv env\n\n# Activate the virtual env.\n. env/bin/activate\n\n# Install sphinx and other dependencies.\npip install -r requirements.txt\n\ncd ../\n\n# Clone this theme.\ngit clone git@github.com/cakephp/sphinxtheme\ncd sphinxtheme\n\n# Install cakephpsphinx as an 'editable' package.\npip install -e .\n```\n\nYou should now be able to preview changes to your docs theme by rebuilding the\ndocumentation.\n\n## Publishing Releases\n\n1. Update `__version__` in setup.py\n2. Commit changes to `setup.py`\n3. Create a new tag\n4. Publish a wheel `python setup.py bdist_wheel upload`\n\n## Option 2 - Developing/Testing changes to this theme\n\nIf you prefer to stay within github universe and provide changes via pull requests, you can do\n```bash\n# Go to target directory, where you want clone cakephp/docs and cakephp/sphinxtheme into\n# In our case we do it in the users home directory \ncd ~\n\n# Clone the docs (follow installation guidelines of cakephp/docs)\n# Note/recommendation: better work with your own fork of cakephp/docs \n\ngit clone git@github.com:cakephp/docs\ncd cake_docs\n\n# Install sphinx and other requirements for cakephp/docs\npip install -r requirements.txt\n```\n\nThis will install also cakespinx theme as python distribution package in your /usr/local/lib/\u003cpython\u003e/dist-packages/cakephpsphinx. \nWe come back to it in the later step.\n\n```bash\n# Clone the cakephp sphinx theme\n# Note/recommendation: better work with your own fork of cakephp/sphinxtheme\ncd ~\ngit clone git@github.com:cakephp/sphinxtheme\n\n# Link clone of sphinxtheme with cakephp/docs\ncd /usr/local/lib/\u003cpyhton\u003e/dist-packages/cakephpsphinx/themes \nln -s ~/cakephpsphinx/themes themes\n```\n\nNow you can change the theme as well the cakephp docs.\nThe build command (e.g. make html-en) in cakephp will use your theme files of your local cakephp/sphinxtheme repository. You can push your changes and create pull-requests for cakephp/docs and cakephp/sphinxtheme via github.\n\n## License\n\n[MIT License](LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcakephp%2Fsphinxtheme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcakephp%2Fsphinxtheme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcakephp%2Fsphinxtheme/lists"}