Skip to content

Commit

Permalink
Fixes in documentation commands
Browse files Browse the repository at this point in the history
  • Loading branch information
susuhahnml committed Feb 7, 2024
1 parent 71fd931 commit 82edc6b
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
## Installation

```shell
```bash
pip install .
```

## Usage

```shell
```bash
fillname -h
```

Expand Down
3 changes: 3 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
16 changes: 8 additions & 8 deletions doc/content/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ 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


The python fillname package can be found [here](https://pypi.org/project/fillname/).

```shell
pip install fillname
```console
$ pip install fillname
```

## Development
Expand All @@ -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]
```
4 changes: 2 additions & 2 deletions doc/content/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

A simple explanation on how to use the system.

```shell
fillname -h
```console
$ fillname -h
```

```{tip}
Expand Down
1 change: 1 addition & 0 deletions tests/test_main.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""
Test cases for main application functionality.
"""

import logging
from io import StringIO
from unittest import TestCase
Expand Down

0 comments on commit 82edc6b

Please sign in to comment.