Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Oct 11, 2022
1 parent 6e49343 commit 9fd01cc
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 18 deletions.
6 changes: 4 additions & 2 deletions COPYING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,7 @@ change to one of the IPython repositories.
With this in mind, the following banner should be used in any source code file
to indicate the copyright and license terms:

# Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
```
# Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
```
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,16 @@ the pre-commit hook should take care of how it should look.

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

pip install pre-commit
pre-commit install
```
pip install pre-commit
pre-commit install
```

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

pre-commit run
```
pre-commit run
```

which should run any autoformatting on your code
and tell you about any errors it couldn't fix automatically.
Expand Down
42 changes: 29 additions & 13 deletions docs/readme-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,39 +7,53 @@ is hosted on ReadTheDocs.

#### Change directory to documentation root:

cd docs
```
cd docs
```

#### Create environment

- [**conda**] Create conda env (and install relevant dependencies):
- \[**conda**\] Create conda env (and install relevant dependencies):

conda env create -f environment.yml
```
conda env create -f environment.yml
```

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

virtualenv traitlets_docs -p python3
pip install -r requirements.txt
```
virtualenv traitlets_docs -p python3
pip install -r requirements.txt
```

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

- [**conda**] Activate conda env:
- \[**conda**\] Activate conda env:

source activate traitlets_docs
```
source activate traitlets_docs
```

- [**pip**] The virtualenv should have been automatically activated. If
- \[**pip**\] The virtualenv should have been automatically activated. If
not:

source activate
```
source activate
```

#### Build documentation using:

- Makefile for Linux and OS X:

make html
```
make html
```

- make.bat for Windows:

make.bat html
```
make.bat html
```

#### Display the documentation locally

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

python -m http.server 8000
```
python -m http.server 8000
```

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

Expand Down

0 comments on commit 9fd01cc

Please sign in to comment.