Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial support for argcomplete for KVArgParseConfigLoader #811

Merged
merged 30 commits into from Dec 19, 2022
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
f5c3b35
Initial support for argcomplete for KVArgParseConfigLoader
azjps Dec 7, 2022
632a7b1
Custom argcomplete.CompletionFinder for class traits
azjps Dec 8, 2022
e36f12c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 8, 2022
c0c6aab
Example application for testing argcomplete
azjps Dec 9, 2022
6522562
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 9, 2022
032eabc
Initial traitlets subcommand support for argcomplete
azjps Dec 11, 2022
4a23a18
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2022
76e9926
Documentation updates
azjps Dec 13, 2022
071e49e
noqa for import argcomplete, more doc updates
azjps Dec 14, 2022
6035ce5
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 14, 2022
49b0ebf
Add unit tests for argcomplete & Application
azjps Dec 14, 2022
ce5b33c
Lint fixes
azjps Dec 14, 2022
cae0e7a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 15, 2022
83feebb
Fix argcomplete unit tests for argcomplete >= 2.0
azjps Dec 15, 2022
25b15a5
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 15, 2022
ee16f06
Skip failing unit tests?
azjps Dec 15, 2022
53ba046
More fixes to appease ruff
azjps Dec 15, 2022
74e338b
Merge remote-tracking branch 'origin/main' into argcomplete2
azjps Dec 15, 2022
56ab3ad
Restore argcomplete unit tests
azjps Dec 15, 2022
53e1f54
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 15, 2022
57c6ec9
Minor, fix mdformat lint sourcecode -> code-block
azjps Dec 15, 2022
93ef5b0
Use StringIO instead of TemporaryFile for argcomplete unit tests
azjps Dec 16, 2022
b430a41
Require argcomplete>=2.0 for tests
azjps Dec 16, 2022
0469b3f
Disable _ARC_DEBUG
azjps Dec 16, 2022
0deadcc
Add pytest-mock and mock os.fdopen for argcomplete
azjps Dec 17, 2022
0a26ed9
Fix pyproject.toml changes, a few more examples/docs
azjps Dec 17, 2022
417d0ee
Ignore examples/docs/configs/ from pytest, mypy
azjps Dec 17, 2022
becdc22
Update corresponding example configs paths in docs
azjps Dec 17, 2022
33957f2
Undo changelog.md for release
azjps Dec 19, 2022
52d27fd
Merge branch 'main' into argcomplete
azjps Dec 19, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 12 additions & 2 deletions CHANGELOG.md
Expand Up @@ -2,6 +2,18 @@

<!-- <START NEW CHANGELOG ENTRY> -->

## 5.8.0
blink1073 marked this conversation as resolved.
Show resolved Hide resolved

### Enhancements made

- Shell command-line tab-completion via `argcomplete` [#811](https://github.com/ipython/traitlets/pull/811) ([@azjps](https://github.com/azjps))

### Maintenance and upkeep improvements

- Additional `Application` examples and docs [#811](https://github.com/ipython/traitlets/pull/811) ([@azjps](https://github.com/azjps))

<!-- <END NEW CHANGELOG ENTRY> -->

## 5.7.1

([Full Changelog](https://github.com/ipython/traitlets/compare/v5.7.0...aa0d38bf02d34a6df788477da30eac6e58ffbda5))
Expand All @@ -16,8 +28,6 @@

[@maartenbreddels](https://github.com/search?q=repo%3Aipython%2Ftraitlets+involves%3Amaartenbreddels+updated%3A2022-12-08..2022-12-12&type=Issues)

<!-- <END NEW CHANGELOG ENTRY> -->

## 5.7.0

([Full Changelog](https://github.com/ipython/traitlets/compare/v5.6.0...f07afea52cf6314bc20571c52409ff6cb115a709))
Expand Down
49 changes: 19 additions & 30 deletions docs/readme-docs.md
@@ -1,47 +1,38 @@
# Documenting traitlets

[Documentation for `traitlets`](https://traitlets.readthedocs.io/en/latest/)
is hosted on ReadTheDocs.
[Documentation for `traitlets`](https://traitlets.readthedocs.io/en/latest/) is hosted on ReadTheDocs.

## Build documentation locally

#### Change directory to documentation root:
With [`hatch`](https://hatch.pypa.io/), one can build environments, docs, and serve it in one command:

```
cd docs
pip install hatch
hatch run docs:build
```

#### Create environment
#### Build documentation manually

- \[**conda**\] Create conda env (and install relevant dependencies):
Otherwise to build docs manually,

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

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

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

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

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

```
source activate traitlets_docs
```
pip install -r traitlets[docs]
```

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

```
source activate
```
```
source activate
```

#### Build documentation using:
##### Build documentation using:

- Makefile for Linux and OS X:

Expand All @@ -55,7 +46,7 @@ cd docs
make.bat html
```

#### Display the documentation locally
##### Display the documentation locally

- Navigate to `build/html/index.html` in your browser.

Expand All @@ -77,5 +68,3 @@ cd docs
- `source/conf.py` - Sphinx build configuration file
- `source` directory - source for documentation
- `source/index.rst` - Main landing page of the Sphinx documentation
- `requirements.txt` - list of packages to install when using pip
- `environment.yml` - list of packages to install when using conda