Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: jupyterhub/jupyterhub-sphinx-theme
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 0.0.2
Choose a base ref
...
head repository: jupyterhub/jupyterhub-sphinx-theme
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 0.0.3
Choose a head ref
  • 3 commits
  • 2 files changed
  • 2 contributors

Commits on Feb 27, 2023

  1. Verified

    This commit was signed with the committer’s verified signature.
    minrk Min RK
    Copy the full SHA
    fac659d View commit details
  2. update version to 0.0.3

    minrk committed Feb 27, 2023

    Verified

    This commit was signed with the committer’s verified signature.
    minrk Min RK
    Copy the full SHA
    e0e9f43 View commit details
  3. Merge pull request #7 from minrk/release-steps

    Mention updating version in release steps
    choldgraf authored Feb 27, 2023

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    d4071da View commit details
Showing with 11 additions and 6 deletions.
  1. +10 −5 README.md
  2. +1 −1 src/jupyterhub_sphinx_theme/__init__.py
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -41,24 +41,24 @@ Follow these steps:
# in requirements.txt
git+https://github.com/jupyterhub/jupyterhub-sphinx-theme
```

or to install locally

```console
$ pip install git+https://github.com/jupyterhub/jupyterhub-sphinx-theme
```
2. Configure the Sphinx docs to use the theme by editing `conf.py`

```{code-block} python
:caption: conf.py
html_theme = "jupyterhub_sphinx_theme"
```
3. Add it to your theme's extensions:

```{code-block} python
:caption: conf.py
extensions = [
"jupyterhub_sphinx_theme"
]
@@ -111,5 +111,10 @@ $ nox -s docs-live

## Make a release

To make a release, [make a release on GitHub](https://github.com/jupyterhub/jupyterhub-sphinx-theme/releases).
To make a release:

- update the version number in `src/jupyterhub_sphinx_theme/__init__.py`
- push the changes
- [make a release on GitHub](https://github.com/jupyterhub/jupyterhub-sphinx-theme/releases).

When you finish this process, a GitHub Action will trigger to package and upload the release to PyPI.
2 changes: 1 addition & 1 deletion src/jupyterhub_sphinx_theme/__init__.py
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
from pathlib import Path
from sphinx.util import logging

__version__ = "0.0.1"
__version__ = "0.0.3"

THEME_PATH = (Path(__file__).parent / "theme" / "jupyterhub-sphinx-theme").resolve()