Skip to content

Commit 9fd01cc

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent 6e49343 commit 9fd01cc

File tree

3 files changed

+40
-18
lines changed

3 files changed

+40
-18
lines changed

COPYING.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -58,5 +58,7 @@ change to one of the IPython repositories.
5858
With this in mind, the following banner should be used in any source code file
5959
to indicate the copyright and license terms:
6060

61-
# Copyright (c) IPython Development Team.
62-
# Distributed under the terms of the Modified BSD License.
61+
```
62+
# Copyright (c) IPython Development Team.
63+
# Distributed under the terms of the Modified BSD License.
64+
```

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,16 @@ the pre-commit hook should take care of how it should look.
6565

6666
To install `pre-commit` locally, run the following::
6767

68-
pip install pre-commit
69-
pre-commit install
68+
```
69+
pip install pre-commit
70+
pre-commit install
71+
```
7072

7173
You can invoke the pre-commit hook by hand at any time with::
7274

73-
pre-commit run
75+
```
76+
pre-commit run
77+
```
7478

7579
which should run any autoformatting on your code
7680
and tell you about any errors it couldn't fix automatically.

docs/readme-docs.md

+29-13
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,53 @@ is hosted on ReadTheDocs.
77

88
#### Change directory to documentation root:
99

10-
cd docs
10+
```
11+
cd docs
12+
```
1113

1214
#### Create environment
1315

14-
- [**conda**] Create conda env (and install relevant dependencies):
16+
- \[**conda**\] Create conda env (and install relevant dependencies):
1517

16-
conda env create -f environment.yml
18+
```
19+
conda env create -f environment.yml
20+
```
1721

18-
- [**pip**] Create virtual environment (and install relevant dependencies):
22+
- \[**pip**\] Create virtual environment (and install relevant dependencies):
1923

20-
virtualenv traitlets_docs -p python3
21-
pip install -r requirements.txt
24+
```
25+
virtualenv traitlets_docs -p python3
26+
pip install -r requirements.txt
27+
```
2228

2329
#### Activate the newly built environment `traitlets_docs`
2430

25-
- [**conda**] Activate conda env:
31+
- \[**conda**\] Activate conda env:
2632

27-
source activate traitlets_docs
33+
```
34+
source activate traitlets_docs
35+
```
2836

29-
- [**pip**] The virtualenv should have been automatically activated. If
37+
- \[**pip**\] The virtualenv should have been automatically activated. If
3038
not:
3139

32-
source activate
40+
```
41+
source activate
42+
```
3343

3444
#### Build documentation using:
3545

3646
- Makefile for Linux and OS X:
3747

38-
make html
48+
```
49+
make html
50+
```
3951

4052
- make.bat for Windows:
4153

42-
make.bat html
54+
```
55+
make.bat html
56+
```
4357

4458
#### Display the documentation locally
4559

@@ -48,7 +62,9 @@ is hosted on ReadTheDocs.
4862
- Or alternatively you may run a local server to display
4963
the docs. In Python 3:
5064

51-
python -m http.server 8000
65+
```
66+
python -m http.server 8000
67+
```
5268

5369
In your browser, go to `http://localhost:8000`.
5470

0 commit comments

Comments
 (0)