Skip to content

Commit

Permalink
Remove sphinx-prompt
Browse files Browse the repository at this point in the history
  • Loading branch information
chdemko committed Aug 29, 2024
1 parent b2e9396 commit 801e64b
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 57 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ repos:
- id: teyit

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.6.2
rev: v0.6.3
hooks:
- id: ruff
language: system
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ pre-installed on linux and Mac OS X, and which is easily installed

Install *pandoc-numbering* using the bash command

~~~{prompt} bash
pipx install pandoc-numbering
~~~shell-session
$ pipx install pandoc-numbering
~~~

To upgrade to the most recent release, use

~~~{prompt} bash
pipx upgrade pandoc-numbering
~~~shell-session
$ pipx upgrade pandoc-numbering
~~~

`pipx` is a script to install and run python applications in isolated environments from the Python Package Index, [PyPI]. It can be installed using instructions given [here](https://pipx.pypa.io/stable/).
Expand All @@ -57,8 +57,8 @@ LaTeX package. On linux you have to install some extra libraries **before**
*pandoc-numbering*. On a Debian-based system (including Ubuntu), you can
install it as root using

~~~{prompt} bash
sudo apt-get install texlive-latex-extra
~~~shell-session
$ sudo apt-get install texlive-latex-extra
~~~

[python]: https://www.python.org/
Expand All @@ -82,9 +82,9 @@ Instructions

Install `poetry`, then run

~~~{prompt} bash
poetry install
poetry shell
~~~shell-session
$ poetry install
$ poetry shell
~~~

And submit your changes. When you commit, hooks will be executed to check
Expand Down
6 changes: 5 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@
# 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_parser", "sphinx_prompt", "sphinx_copybutton"]
extensions = ["myst_parser", "sphinx_copybutton"]

copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
copybutton_prompt_is_regexp = True
copybutton_line_continuation_character = "\\"

# Add any paths that contain templates here, relative to this directory.
templates_path = []
Expand Down
4 changes: 2 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Usage

Run `pandoc` using ``pandoc-numbering`` filter:

.. prompt:: bash
.. code-block:: shell-session
pandoc --filter pandoc-numbering
$ pandoc --filter pandoc-numbering
.. toctree::
Expand Down
74 changes: 31 additions & 43 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@ optional = true
myst-parser = "^2.0"
Sphinx = "^7.2.6"
sphinx-rtd-theme = "^2.0.0"
sphinx-prompt = "^1.8.0"
sphinx-copybutton = "^0.5.2"

[tool.poetry.scripts]
Expand Down

0 comments on commit 801e64b

Please sign in to comment.