Skip to content

Commit a7f4a42

Browse files
authored
RELEASE: v0.3.0 (#34)
1 parent 9e73e2e commit a7f4a42

File tree

10 files changed

+27
-61
lines changed

10 files changed

+27
-61
lines changed

.github/workflows/tests.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ jobs:
1212
steps:
1313
- name: Checkout source
1414
uses: actions/checkout@v2
15-
- name: Set up Python 3.7
15+
- name: Set up Python 3.8
1616
uses: actions/setup-python@v1
1717
with:
18-
python-version: 3.7
18+
python-version: "3.8"
1919
- name: Build package
2020
run: |
21-
pip install wheel
22-
python setup.py sdist bdist_wheel
21+
pip install build
22+
python -m build
2323
- name: Publish
2424
uses: pypa/gh-action-pypi-publish@v1.1.0
2525
with:

CHANGELOG.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,27 @@
1-
# v0.2.0...v0.2.2
1+
# Changelog
2+
3+
## v0.3.0
4+
5+
([full changelog](https://github.com/executablebooks/sphinx-togglebutton/compare/v0.2.3...9e73e2e1a673d2485dd8c8d56510cdf910531f1a))
6+
7+
### Enhancements made
8+
9+
- ENH: Enhance toggle button design and layout [#32](https://github.com/executablebooks/sphinx-togglebutton/pull/32) ([@choldgraf](https://github.com/choldgraf))
10+
- IMPROVE: Allow clicking on whole admonition title [#29](https://github.com/executablebooks/sphinx-togglebutton/pull/29) ([@rkdarst](https://github.com/rkdarst))
11+
- ENHANCE: Improve hiding behavior for togglebuttons [#33](https://github.com/executablebooks/sphinx-togglebutton/pull/33) ([@choldgraf](https://github.com/choldgraf))
12+
13+
## v0.2.2
214
([full changelog](https://github.com/executablebooks/sphinx-togglebutton/compare/v0.2.0...v0.2.2))
315

416

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

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

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

1527
[@choldgraf](https://github.com/search?q=repo%3Aexecutablebooks%2Fsphinx-togglebutton+involves%3Acholdgraf+updated%3A2020-06-09..2020-08-08&type=Issues)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sections of your page. This allows you to:
77
until users click a toggle button.
88
- Collapse arbitrary chunks of content on your page with a `collapse` directive.
99

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

1212

1313
Installation

docs/_static/demo.gif

-535 KB
Binary file not shown.

docs/changelog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../CHANGELOG.md
2+
```

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
# Add any Sphinx extension module names here, as strings. They can be
3939
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
4040
# ones.
41-
extensions = ["myst_nb", "sphinx_design", "sphinx_togglebutton"]
41+
extensions = ["myst_parser", "sphinx_design", "sphinx_togglebutton"]
4242

4343
# Add any paths that contain templates here, relative to this directory.
4444
templates_path = ["_templates"]

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,5 @@ See {ref}`usage` for information about how to use `sphinx-togglebutton`.
8181
:maxdepth: 2
8282
use
8383
reference/index
84+
changelog
8485
```

docs/reference/index.md

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
---
2-
jupytext:
3-
formats: md:myst
4-
text_representation:
5-
extension: .md
6-
format_name: myst
7-
format_version: 0.13
8-
jupytext_version: 1.11.5
9-
kernelspec:
10-
display_name: Python 3 (ipykernel)
11-
language: python
12-
name: python3
13-
---
14-
151
# Reference examples
162

173
This page shows the most common ways that `sphinx-togglebutton` is used as a reference.
@@ -75,38 +61,3 @@ Admonition content.
7561
```{image} https://jupyterbook.org/_static/logo-wide.svg
7662
```
7763
:::
78-
79-
## MyST-NB Cells
80-
81-
```{code-cell}
82-
from matplotlib import pyplot as plt
83-
import numpy as np
84-
data = np.random.randn(3, 100)
85-
```
86-
87-
### Hide Input
88-
89-
```{code-cell}
90-
:tags: [hide-input]
91-
92-
fig, ax = plt.subplots()
93-
ax.scatter(data[0], data[1], c=np.abs(data[2]))
94-
```
95-
96-
### Hide Output
97-
98-
```{code-cell}
99-
:tags: [hide-output]
100-
101-
fig, ax = plt.subplots()
102-
ax.scatter(data[0], data[1], c=np.abs(data[2]))
103-
```
104-
105-
### Hide Both
106-
107-
```{code-cell}
108-
:tags: [hide-cell]
109-
110-
fig, ax = plt.subplots()
111-
ax.scatter(data[0], data[1], c=np.abs(data[2]))
112-
```

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@
2727
"sphinx_togglebutton": ["_static/togglebutton.css", "_static/togglebutton.js", "_static/togglebutton-chevron.svg"]
2828
},
2929
install_requires=["setuptools", "wheel", "sphinx", "docutils"],
30-
extras_require={"sphinx": ["matplotlib", "myst_nb", "sphinx_book_theme", "sphinx_design"]},
30+
extras_require={"sphinx": ["myst_parser", "sphinx_book_theme", "sphinx_design"]},
3131
classifiers=["License :: OSI Approved :: MIT License"],
3232
)

sphinx_togglebutton/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from docutils.parsers.rst import Directive, directives
44
from docutils import nodes
55

6-
__version__ = "0.2.3"
6+
__version__ = "0.3.0"
77

88

99
def st_static_path(app):

0 commit comments

Comments
 (0)