diff --git a/README.md b/README.md index 0f57031..4f10057 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ ## Installation -```shell +```bash pip install . ``` ## Usage -```shell +```bash fillname -h ``` diff --git a/doc/conf.py b/doc/conf.py index f16b904..b02d1ab 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -121,3 +121,6 @@ # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] + +copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " +copybutton_prompt_is_regexp = True diff --git a/doc/content/installation.md b/doc/content/installation.md index 2fa01c9..d5cb677 100644 --- a/doc/content/installation.md +++ b/doc/content/installation.md @@ -4,8 +4,8 @@ fillname requires Python 3.8+. We recommend version 3.10. You can check a successful installation by running -```shell -fillname -h +```console +$ fillname -h ``` ## Installing with pip @@ -13,8 +13,8 @@ fillname -h The python fillname package can be found [here](https://pypi.org/project/fillname/). -```shell -pip install fillname +```console +$ pip install fillname ``` ## Development @@ -34,8 +34,8 @@ The `setuptools` package is required to run the commands below. Execute the following command in the top level fillname directory: -```shell -git clone https://github.com/potassco/fillname -cd fillname -pip install -e .[all] +```console +$ git clone https://github.com/potassco/fillname +$ cd fillname +$ pip install -e .[all] ``` diff --git a/doc/content/quickstart.md b/doc/content/quickstart.md index 9ed6151..91841a9 100644 --- a/doc/content/quickstart.md +++ b/doc/content/quickstart.md @@ -2,8 +2,8 @@ A simple explanation on how to use the system. -```shell -fillname -h +```console +$ fillname -h ``` ```{tip} diff --git a/tests/test_main.py b/tests/test_main.py index a768bb6..b1e7f19 100644 --- a/tests/test_main.py +++ b/tests/test_main.py @@ -1,6 +1,7 @@ """ Test cases for main application functionality. """ + import logging from io import StringIO from unittest import TestCase