Skip to content

Commit

Permalink
RELEASE: v0.3.0 (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
choldgraf authored Feb 6, 2022
1 parent 9e73e2e commit a7f4a42
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 61 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ jobs:
steps:
- name: Checkout source
uses: actions/checkout@v2
- name: Set up Python 3.7
- name: Set up Python 3.8
uses: actions/setup-python@v1
with:
python-version: 3.7
python-version: "3.8"
- name: Build package
run: |
pip install wheel
python setup.py sdist bdist_wheel
pip install build
python -m build
- name: Publish
uses: pypa/[email protected]
with:
Expand Down
20 changes: 16 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,27 @@
# v0.2.0...v0.2.2
# Changelog

## v0.3.0

([full changelog](https://github.com/executablebooks/sphinx-togglebutton/compare/v0.2.3...9e73e2e1a673d2485dd8c8d56510cdf910531f1a))

### Enhancements made

- ENH: Enhance toggle button design and layout [#32](https://github.com/executablebooks/sphinx-togglebutton/pull/32) ([@choldgraf](https://github.com/choldgraf))
- IMPROVE: Allow clicking on whole admonition title [#29](https://github.com/executablebooks/sphinx-togglebutton/pull/29) ([@rkdarst](https://github.com/rkdarst))
- ENHANCE: Improve hiding behavior for togglebuttons [#33](https://github.com/executablebooks/sphinx-togglebutton/pull/33) ([@choldgraf](https://github.com/choldgraf))

## v0.2.2
([full changelog](https://github.com/executablebooks/sphinx-togglebutton/compare/v0.2.0...v0.2.2))


## Bugs fixed
### Bugs fixed
* 🐛 BUG: fixing toggle button text overlap on narrow screens [#17](https://github.com/executablebooks/sphinx-togglebutton/pull/17) ([@choldgraf](https://github.com/choldgraf))
* 🐛 BUG: Fixing overlapping title on hidden admonitions [#15](https://github.com/executablebooks/sphinx-togglebutton/pull/15) ([@choldgraf](https://github.com/choldgraf))

## Documentation improvements
### Documentation improvements
* 📚 DOC: release docs and removing circle [#16](https://github.com/executablebooks/sphinx-togglebutton/pull/16) ([@choldgraf](https://github.com/choldgraf))

## Contributors to this release
### Contributors to this release
([GitHub contributors page for this release](https://github.com/executablebooks/sphinx-togglebutton/graphs/contributors?from=2020-06-09&to=2020-08-08&type=c))

[@choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2Fsphinx-togglebutton+involves%3Acholdgraf+updated%3A2020-06-09..2020-08-08&type=Issues)
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sections of your page. This allows you to:
until users click a toggle button.
- Collapse arbitrary chunks of content on your page with a `collapse` directive.

![demo gif](docs/_static/demo.gif)
![Demonstration of Sphinx Togglebutton](https://user-images.githubusercontent.com/1839645/152654312-a72a320f-e1e0-40be-95ae-3ed34facc4d3.gif)


Installation
Expand Down
Binary file removed docs/_static/demo.gif
Binary file not shown.
2 changes: 2 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
```{include} ../CHANGELOG.md
```
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ["myst_nb", "sphinx_design", "sphinx_togglebutton"]
extensions = ["myst_parser", "sphinx_design", "sphinx_togglebutton"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,5 @@ See {ref}`usage` for information about how to use `sphinx-togglebutton`.
:maxdepth: 2
use
reference/index
changelog
```
49 changes: 0 additions & 49 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,3 @@
---
jupytext:
formats: md:myst
text_representation:
extension: .md
format_name: myst
format_version: 0.13
jupytext_version: 1.11.5
kernelspec:
display_name: Python 3 (ipykernel)
language: python
name: python3
---

# Reference examples

This page shows the most common ways that `sphinx-togglebutton` is used as a reference.
Expand Down Expand Up @@ -75,38 +61,3 @@ Admonition content.
```{image} https://jupyterbook.org/_static/logo-wide.svg
```
:::

## MyST-NB Cells

```{code-cell}
from matplotlib import pyplot as plt
import numpy as np
data = np.random.randn(3, 100)
```

### Hide Input

```{code-cell}
:tags: [hide-input]
fig, ax = plt.subplots()
ax.scatter(data[0], data[1], c=np.abs(data[2]))
```

### Hide Output

```{code-cell}
:tags: [hide-output]
fig, ax = plt.subplots()
ax.scatter(data[0], data[1], c=np.abs(data[2]))
```

### Hide Both

```{code-cell}
:tags: [hide-cell]
fig, ax = plt.subplots()
ax.scatter(data[0], data[1], c=np.abs(data[2]))
```
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@
"sphinx_togglebutton": ["_static/togglebutton.css", "_static/togglebutton.js", "_static/togglebutton-chevron.svg"]
},
install_requires=["setuptools", "wheel", "sphinx", "docutils"],
extras_require={"sphinx": ["matplotlib", "myst_nb", "sphinx_book_theme", "sphinx_design"]},
extras_require={"sphinx": ["myst_parser", "sphinx_book_theme", "sphinx_design"]},
classifiers=["License :: OSI Approved :: MIT License"],
)
2 changes: 1 addition & 1 deletion sphinx_togglebutton/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from docutils.parsers.rst import Directive, directives
from docutils import nodes

__version__ = "0.2.3"
__version__ = "0.3.0"


def st_static_path(app):
Expand Down

0 comments on commit a7f4a42

Please sign in to comment.