{"id":24562559,"url":"https://github.com/humanbrainproject/hbp-sphinx-theme","last_synced_at":"2025-04-19T17:42:38.392Z","repository":{"id":36287761,"uuid":"40592282","full_name":"HumanBrainProject/hbp-sphinx-theme","owner":"HumanBrainProject","description":"A Sphinx theme for doc integrated in the HBP Collaboratory","archived":false,"fork":false,"pushed_at":"2020-07-15T20:26:14.000Z","size":342,"stargazers_count":4,"open_issues_count":2,"forks_count":4,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-04-13T21:40:25.534Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HumanBrainProject.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-12T09:30:35.000Z","updated_at":"2024-08-31T17:54:08.000Z","dependencies_parsed_at":"2022-09-10T05:40:36.283Z","dependency_job_id":null,"html_url":"https://github.com/HumanBrainProject/hbp-sphinx-theme","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HumanBrainProject%2Fhbp-sphinx-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HumanBrainProject%2Fhbp-sphinx-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HumanBrainProject%2Fhbp-sphinx-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HumanBrainProject%2Fhbp-sphinx-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HumanBrainProject","download_url":"https://codeload.github.com/HumanBrainProject/hbp-sphinx-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249751581,"owners_count":21320331,"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-01-23T09:16:14.865Z","updated_at":"2025-04-19T17:42:38.375Z","avatar_url":"https://github.com/HumanBrainProject.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":".. _collaboratory: https://collab.humanbrainproject.eu\n.. _bower: http://www.bower.io\n.. _sphinx: http://www.sphinx-doc.org\n.. _sass: http://www.sass-lang.com\n.. _wyrm: http://www.github.com/snide/wyrm/\n.. _grunt: http://www.gruntjs.com\n.. _node: http://www.nodejs.com\n.. _demo: https://collab.humanbrainproject.eu/#/collab/54/nav/368\n.. _repository: https://github.com/HumanBrainProject/hbp-sphinx-theme\n.. _release: https://github.com/HumanBrainProject/hbp-sphinx-theme/releases/latest\n.. _documentation example: https://github.com/HumanBrainProject/hbp-collaboratory-doc-example\n\n.. image:: https://travis-ci.org/HumanBrainProject/hbp-sphinx-theme.svg?branch=master\n    :target: https://travis-ci.org/HumanBrainProject/hbp-sphinx-theme\n\n******************************\nHBP Collaboratory Sphinx Theme\n******************************\n\n.. contents::\n\nView a working demo_ over on collaboratory_.\n\nThis package provide a Sphinx theme for documentation integrated into the\nCollaboratory. It can be used for standalone websites as well.\n\n.. image:: screen_integrated.png\n    :width: 100%\n\nInstallation\n============\n\nVia package\n-----------\n\nDownload the package or add it to your requirements.txt file:\n\n.. code:: bash\n\n   pip install hbp_sphinx_theme\n\n\nIn your conf.py file:\n\n.. code:: Python\n\n   import hbp_sphinx_theme\n   html_theme = \"hbp_sphinx_theme\"\n   html_theme_path = [hbp_sphinx_theme.get_html_theme_path()]\n\n\nVia download\n------------\n\nDownload the ``hbp_sphinx_theme.zip`` provided by the latest release_\nto your documentation project directory.\n\nAs explained in `sphinx documentation`__, in your ``conf.py`` file:\n\n__ http://sphinx-doc.org/theming.html#using-a-theme\n\n\n.. code:: python\n\n    html_theme = 'hbp_sphinx_theme'\n    html_theme_path = ['.']\n\n\nContributing or modifying the theme\n===================================\n\nHBP Collaboratory Sphinx Theme github project can be included in your documentation\nproject as a git submodule. This will enable you to modify the theme and see the\nchanges immediately in your browser. Please have a look at the `documentation example`_\nproject on how to set up. After you are happy with the changes, you've made to the theme,\nplease make a pull request for us to review.\n\nBuild and release the theme\n===========================\n\nThe build and release is done using grunt.\n\n.. code:: bash\n\n    grunt release\n\n`Changelog`__\n\n__ CHANGELOG.md\n\nAcknowledgement\n===============\n\nThis open source software code was developed in part or in whole in the Human Brain Project, funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 720270 (Human Brain Project SGA1).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhumanbrainproject%2Fhbp-sphinx-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhumanbrainproject%2Fhbp-sphinx-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhumanbrainproject%2Fhbp-sphinx-theme/lists"}