Metadata-Version: 2.1
Name: quantecon-book-theme
Version: 0.2.2
Summary: Theme for Quantecon lectures
Home-page: UNKNOWN
Author: Project Jupyter Contributors
Author-email: jupyter@googlegroups.com
License: BSD
Keywords: reproducible science environments scholarship notebook
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: pyyaml
Requires-Dist: docutils (>=0.15)
Requires-Dist: sphinx
Requires-Dist: click
Requires-Dist: setuptools
Requires-Dist: libsass (~=0.20.1)
Requires-Dist: sphinx-book-theme (~=0.1.0)
Requires-Dist: beautifulsoup4
Requires-Dist: web-compile
Requires-Dist: importlib-resources (<3.5,>=3.0) ; python_version < "3.7"
Provides-Extra: code_style
Requires-Dist: flake8 (<3.8.0,>=3.7.0) ; extra == 'code_style'
Requires-Dist: black ; extra == 'code_style'
Requires-Dist: pre-commit (~=2.7.0) ; extra == 'code_style'
Provides-Extra: sphinx
Requires-Dist: folium ; extra == 'sphinx'
Requires-Dist: numpy ; extra == 'sphinx'
Requires-Dist: matplotlib ; extra == 'sphinx'
Requires-Dist: ipywidgets ; extra == 'sphinx'
Requires-Dist: pandas ; extra == 'sphinx'
Requires-Dist: nbclient ; extra == 'sphinx'
Requires-Dist: myst-nb (~=0.11.1) ; extra == 'sphinx'
Requires-Dist: sphinx-togglebutton (>=0.2.1) ; extra == 'sphinx'
Requires-Dist: sphinx-copybutton ; extra == 'sphinx'
Requires-Dist: plotly ; extra == 'sphinx'
Requires-Dist: sphinxcontrib-bibtex (~=2.2) ; extra == 'sphinx'
Provides-Extra: testing
Requires-Dist: myst-nb (~=0.11.1) ; extra == 'testing'
Requires-Dist: coverage ; extra == 'testing'
Requires-Dist: pytest (~=6.0.1) ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: beautifulsoup4 ; extra == 'testing'
Requires-Dist: sphinx-thebe ; extra == 'testing'
Requires-Dist: pytest-regressions (~=2.0.1) ; extra == 'testing'
Requires-Dist: sphinx-copybutton ; extra == 'testing'

# quantecon-book-theme
A Jupyter Book Theme for QuantEcon Book Style Projects

## Usage

To use this theme in [Jupyter Book](https://github.com/executablebooks/jupyter-book):

1. Install the theme

  `pip install git+https://github.com/QuantEcon/quantecon-book-theme.git`

2. Add the theme to your `_config.yml` file:

  ```yaml
  sphinx:
      config:
          html_theme: quantecon_book_theme
  ```

## Updating Fixtures for Tests

### Updating test regression files on layout changes

It is advisable to update the test files for file regression checks when releavant layout files change.

For example, at present we have a sidebar file-regression check to validate html across tests.
The file which it compares against is `tests/test_build/test_build_book.html`.

If updating the sidebar html, then one of the easier steps to update this test file is:

1. Delete the file `tests/test_build/test_build_book.html`.
2. 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.

Now future pytests will test against this file, and the subsequent tests should pass.


