Skip to content

Commit d7cdc5d

Browse files
committed
Fix docs
1 parent 2b0e8e2 commit d7cdc5d

2 files changed

Lines changed: 48 additions & 48 deletions

File tree

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -40,43 +40,43 @@ grouped dependency installations.
4040

4141
1. Generate Your Project
4242

43-
Use Cookiecutter to create a new project from the template:
43+
Use Cookiecutter to create a new project from the template:
4444

45-
```bash
46-
cookiecutter https://github.com/danibcorr/python-project-template.git
47-
```
45+
```bash
46+
cookiecutter https://github.com/danibcorr/python-project-template.git
47+
```
4848

49-
Follow the prompts to configure project metadata, package name, and other options.
49+
Follow the prompts to configure project metadata, package name, and other options.
5050

5151
2. Install Dependencies
5252

53-
Activate your virtual environment and install all dependencies using the included
54-
`Makefile`:
53+
Activate your virtual environment and install all dependencies using the included
54+
`Makefile`:
5555

56-
```bash
57-
make install
58-
```
56+
```bash
57+
make install
58+
```
5959

60-
This installs development, testing, and documentation tools as defined in
61-
`pyproject.toml`.
60+
This installs development, testing, and documentation tools as defined in
61+
`pyproject.toml`.
6262

6363
3. Run the Pipeline
6464

65-
Execute the quality pipeline, which includes linting, type checking, security analysis,
66-
complexity checks, and test execution:
65+
Execute the quality pipeline, which includes linting, type checking, security
66+
analysis, complexity checks, and test execution:
6767

68-
```bash
69-
make pipeline
70-
```
68+
```bash
69+
make pipeline
70+
```
7171

7272
4. Run the Full Workflow (Optional)
7373

74-
To perform a complete setup including dependency installation, full quality checks, and
75-
local documentation preview:
74+
To perform a complete setup including dependency installation, full quality checks,
75+
and local documentation preview:
7676

77-
```bash
78-
make all
79-
```
77+
```bash
78+
make all
79+
```
8080

81-
This ensures that the project environment is fully prepared for development and
82-
validation.
81+
This ensures that the project environment is fully prepared for development and
82+
validation.

docs/index.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -40,43 +40,43 @@ grouped dependency installations.
4040

4141
1. Generate Your Project
4242

43-
Use Cookiecutter to create a new project from the template:
43+
Use Cookiecutter to create a new project from the template:
4444

45-
```bash
46-
cookiecutter https://github.com/danibcorr/python-project-template.git
47-
```
45+
```bash
46+
cookiecutter https://github.com/danibcorr/python-project-template.git
47+
```
4848

49-
Follow the prompts to configure project metadata, package name, and other options.
49+
Follow the prompts to configure project metadata, package name, and other options.
5050

5151
2. Install Dependencies
5252

53-
Activate your virtual environment and install all dependencies using the included
54-
`Makefile`:
53+
Activate your virtual environment and install all dependencies using the included
54+
`Makefile`:
5555

56-
```bash
57-
make install
58-
```
56+
```bash
57+
make install
58+
```
5959

60-
This installs development, testing, and documentation tools as defined in
61-
`pyproject.toml`.
60+
This installs development, testing, and documentation tools as defined in
61+
`pyproject.toml`.
6262

6363
3. Run the Pipeline
6464

65-
Execute the quality pipeline, which includes linting, type checking, security analysis,
66-
complexity checks, and test execution:
65+
Execute the quality pipeline, which includes linting, type checking, security
66+
analysis, complexity checks, and test execution:
6767

68-
```bash
69-
make pipeline
70-
```
68+
```bash
69+
make pipeline
70+
```
7171

7272
4. Run the Full Workflow (Optional)
7373

74-
To perform a complete setup including dependency installation, full quality checks, and
75-
local documentation preview:
74+
To perform a complete setup including dependency installation, full quality checks,
75+
and local documentation preview:
7676

77-
```bash
78-
make all
79-
```
77+
```bash
78+
make all
79+
```
8080

81-
This ensures that the project environment is fully prepared for development and
82-
validation.
81+
This ensures that the project environment is fully prepared for development and
82+
validation.

0 commit comments

Comments
 (0)