Merge branch 'main' into no-jupyter-execution

Author: kwankyu

.devcontainer/devcontainer.json

@@ -0,0 +1,9 @@
+{
+  "name": "Python 3",
+  "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
+  "features": {
+    "ghcr.io/devcontainers-contrib/features/hatch:2": {},
+    "ghcr.io/devcontainers-contrib/features/pre-commit:2": {}
+  },
+  "postCreateCommand": "pre-commit install"
+}

.github/workflows/prerelease.yml

@@ -39,6 +39,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
       - name: Install dependencies
         run: pip install hatch
 

.github/workflows/tests.yml

@@ -47,6 +47,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
       - name: Install hatch
         run: pip install hatch
       - name: Build docs

.gitignore

@@ -1,27 +1,160 @@
-.venv
+# Byte-compiled / optimized / DLL files
+__pycache__/
 *.py[cod]
+*$py.class
 
-# Packages
-*.egg
-*.egg-info
-dist
-build
-eggs
-parts
-bin
-var
-sdist
-develop-eggs
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
 .installed.cfg
-lib
-lib64
-__pycache__
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
 
-# Jupyter notebook checkpoints
-.ipynb_checkpoints/
+# pytype static type analyzer
+.pytype/
 
-# OS X
-.DS_Store
+# Cython debug symbols
+cython_debug/
 
-# git
-*.orig
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.pre-commit-config.yaml

@@ -36,17 +36,6 @@ repos:
       - id: prettier
         types_or: [yaml, html, json]
 
-  - repo: https://github.com/adamchainz/blacken-docs
-    rev: "1.16.0"
-    hooks:
-      - id: blacken-docs
-        additional_dependencies: [black==23.7.0]
-        exclude: |
-          (?x)^(
-              doc/source/index.rst|
-              tests/test_execute.py
-          )$(|)
-
   - repo: https://github.com/codespell-project/codespell
     rev: "v2.2.6"
     hooks:
@@ -68,9 +57,3 @@ repos:
         args: ["--fix", "--show-fixes"]
       - id: ruff-format
         types_or: [python, jupyter]
-
-  - repo: https://github.com/scientific-python/cookie
-    rev: "2023.10.27"
-    hooks:
-      - id: sp-repo-review
-        additional_dependencies: ["repo-review[cli]"]

.readthedocs.yml

@@ -1,13 +1,13 @@
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.10"
 sphinx:
-  configuration: doc/source/conf.py
+  configuration: docs/conf.py
 python:
   install:
-    # install itself with pip install .
     - method: pip
       path: .
       extra_requirements:

README.md

@@ -1,5 +1,14 @@
 # Jupyter Sphinx Extensions
 
+[![BSD licence](https://img.shields.io/badge/License-BSD3-yellow.svg?logo=opensourceinitiative&logoColor=white)](LICENSE)
+[![black](https://img.shields.io/badge/code%20style-black-000000)](https://github.com/psf/black)
+[![prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?logo=prettier&logoColor=white)](https://github.com/prettier/prettier)
+[![pre-commit](https://img.shields.io/badge/pre--commit-active-yellow?logo=pre-commit&logoColor=white)](https://pre-commit.com/)
+[![pypi version](https://img.shields.io/pypi/v/jupyter-sphinx?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/jupyter-sphinx/)
+[![conda-forge version badge](https://img.shields.io/conda/vn/conda-forge/jupyter-sphinx?logo=anaconda&logoColor=white&color=blue)](https://anaconda.org/conda-forge/jupyter-sphinx)
+[![tests](https://img.shields.io/github/actions/workflow/status/jupyter/jupyter-sphinx/tests.yml?logo=github&logoColor=white)](https://github.com/jupyter/jupyter-sphinx/actions/workflows/tests.yml)
+[![docs](https://img.shields.io/readthedocs/jupyter-sphinx?logo=readthedocs&logoColor=white)](https://jupyter-sphinx.readthedocs.io/)
+
 `jupyter-sphinx` enables running code embedded in Sphinx documentation and
 embedding output of that code into the resulting document. It has support
 for rich output such as images and even Jupyter interactive widgets.

RELEASE.md

@@ -8,10 +8,10 @@ To cut a new Jupyter Sphinx release, follow these steps:
 - Ensure that all tests are passing on master.
 
 - In [`_version.py`](https://github.com/jupyter/jupyter-sphinx/blob/main/jupyter_sphinx/_version.py),
-  change the "release type" section to "final" e.g.:
+  update the version number:
 
   ```python
-  version_info = (0, 2, 3, "final")
+  __version__ = "0.2.3"
   ```
 
 - Make a release commit and push to main
@@ -24,19 +24,11 @@ To cut a new Jupyter Sphinx release, follow these steps:
 
 - [Create a new github release](https://github.com/jupyter/jupyter-sphinx/releases/new).
   The target should be **main**, the tag and the title should be the version number,
-  e.g. `0.2.3`.
+  e.g. `v0.2.3`.
 
 - Creating the release in GitHub will push a tag commit to the repository, which will
   trigger [a GitHub action](https://github.com/jupyter/jupyter-sphinx/blob/main/.github/workflows/artifacts.yml)
   to build `jupyter-sphinx` and push the new version to PyPI.
   [Confirm that the version has been bumped](https://pypi.org/project/jupyter-sphinx/).
 
-- In [`_version.py`](https://github.com/jupyter/jupyter-sphinx/blob/main/jupyter_sphinx/_version.py),
-  bump the minor version and change the "release type" section to "alpha". **make sure to
-  include a number after the release type**, e.g.:
-
-  ```python
-  version_info = (0, 2, 4, "alpha", 1)
-  ```
-
 - That's it!