{"id":19644968,"url":"https://github.com/quantecon/quantecon-book-theme","last_synced_at":"2026-02-24T00:10:20.316Z","repository":{"id":44638465,"uuid":"293384076","full_name":"QuantEcon/quantecon-book-theme","owner":"QuantEcon","description":"A Jupyter Book Theme for QuantEcon Book Style Projects","archived":false,"fork":false,"pushed_at":"2024-10-25T06:44:13.000Z","size":2676,"stargazers_count":41,"open_issues_count":45,"forks_count":21,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-10-30T04:30:01.659Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QuantEcon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing/architecture.md","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},"funding":{"github":"numfocus","custom":"https://numfocus.org/donate-to-quantecon"}},"created_at":"2020-09-07T00:19:12.000Z","updated_at":"2024-10-25T06:44:14.000Z","dependencies_parsed_at":"2023-01-22T11:45:53.189Z","dependency_job_id":"3b45d959-6a32-4e6e-bd5d-6d0d6317e83f","html_url":"https://github.com/QuantEcon/quantecon-book-theme","commit_stats":{"total_commits":213,"total_committers":7,"mean_commits":"30.428571428571427","dds":0.5492957746478873,"last_synced_commit":"90fba30c2c4d7743333c9567bb8ac82b29871c36"},"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QuantEcon%2Fquantecon-book-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QuantEcon%2Fquantecon-book-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QuantEcon%2Fquantecon-book-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QuantEcon%2Fquantecon-book-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QuantEcon","download_url":"https://codeload.github.com/QuantEcon/quantecon-book-theme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299829,"owners_count":20916190,"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":"2024-11-11T14:31:15.674Z","updated_at":"2026-02-06T06:06:15.380Z","avatar_url":"https://github.com/QuantEcon.png","language":"Jupyter Notebook","funding_links":["https://github.com/sponsors/numfocus","https://numfocus.org/donate-to-quantecon"],"categories":[],"sub_categories":[],"readme":"# quantecon-book-theme\nA Jupyter Book Theme for QuantEcon Book Style Projects\n\n## Features\n\n- **Clean, professional design** optimized for technical and academic documentation\n- **Git-based metadata** - Automatic display of last modified dates and interactive changelog with commit history\n- **Collapsible stderr warnings** - Automatically wraps verbose warnings in notebook cells with an expandable interface\n- **Jupyter Notebook support** with visual classes for cell inputs, outputs, and interactive functionality\n- **Configurable code syntax highlighting** - Choose between custom QuantEcon styles or Pygments built-in themes\n- **Launch buttons** for online interactivity via BinderHub\n- **Flexible content layout** inspired by beautiful online books\n- **Bootstrap 4** for visual elements and functionality\n- **Built on PyData Sphinx Theme** inheriting robust features and design patterns\n\n## Usage\n\nTo use this theme in [Jupyter Book](https://github.com/executablebooks/jupyter-book):\n\n1. Install the theme\n\n  ```bash\n  pip install quantecon-book-theme\n  ```\n\n2. Add the theme to your `_config.yml` file:\n\n  ```yaml\n  sphinx:\n      config:\n          html_theme: quantecon_book_theme\n  ```\n\n### Configuration Options\n\nThe theme supports various configuration options in your `conf.py` or `_config.yml`:\n\n```python\nhtml_theme_options = {\n    \"repository_url\": \"https://github.com/{your-org}/{your-repo}\",\n    \"use_repository_button\": True,\n    \"use_issues_button\": True,\n    \"use_edit_page_button\": True,\n\n    # Git metadata (new in v0.12.0)\n    \"last_modified_date_format\": \"%b %d, %Y\",  # Date format for last modified\n    \"changelog_max_entries\": 10,  # Number of commits to show in changelog\n\n    # Code highlighting (new in v0.10.0)\n    \"qetheme_code_style\": True,  # False to use Pygments built-in styles\n}\n\n# When using Pygments styles\npygments_style = 'friendly'  # or 'monokai', 'github-dark', etc.\n```\n\nSee the [full documentation](https://quantecon-book-theme.readthedocs.io/) for all configuration options.\n\n## Development\n\n### Testing\n\nThis project uses `tox` for running tests across multiple Python versions:\n\n```bash\n# Run full test suite\ntox\n\n# Run pre-commit checks\npre-commit run --all-files\n```\n\n**Important**: Always use `tox` instead of running `pytest` directly to ensure proper environment isolation and multi-version testing.\n\n## Updating Fixtures for Tests\n\n### Updating test regression files on layout changes\n\nIt is advisable to update the test files for file regression checks when releavant layout files change.\n\nFor example, at present we have a sidebar file-regression check to validate html across tests.\nThe file which it compares against is `tests/test_build/test_build_book.html`.\n\nIf updating the sidebar html, then one of the easier steps to update this test file is:\n\n1. Delete the file `tests/test_build/test_build_book.html`.\n2. Run `pytest` in your command line, which will then generate a new file. Check if the file is at par with your expectations, contains elements which you added/modified.\n\nNow future pytests will test against this file, and the subsequent tests should pass.\n\n## Contributing Guide\n\nThe docs for the contributing guide of this repository: https://github.com/QuantEcon/quantecon-book-theme/blob/master/docs/contributing/index.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquantecon%2Fquantecon-book-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquantecon%2Fquantecon-book-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquantecon%2Fquantecon-book-theme/lists"}