Commit graph

89 commits

Author SHA1 Message Date
Andy Kipp
1d7cc00962
refactoring: move shell to shells.shell to avoid unwanted init (#5556)
Continue #5550 for https://github.com/xonsh/xonsh/issues/5538 

---------

Co-authored-by: a <1@1.1>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Noorhteen Raja NJ <jnoortheen@gmail.com>
2024-06-29 14:26:50 +05:30
Andy Kipp
0bece0f5e4
refactoring: move jobs to procs (#5547)
#5538

Co-authored-by: a <1@1.1>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2024-06-29 12:21:10 +05:30
Andy Kipp
b9998ac5be
refactoring: move jsonutils to lib (#5548)
https://github.com/xonsh/xonsh/issues/5538

## For community
⬇️ **Please click the 👍 reaction instead of leaving a `+1` or 👍
comment**

Co-authored-by: a <1@1.1>
2024-06-29 00:46:04 +02:00
Noorhteen Raja NJ
3716f3da86
Pr5 xontrib entrypoints (#4827) 2022-06-17 12:39:12 -04:00
Noorhteen Raja NJ
347bf201de
fix: docs building (#4820) 2022-05-30 20:49:38 +05:30
Noorhteen Raja NJ
9fbecfc155
feat: use github actions to deploy docs (#4641)
* feat: use github actions to deploy docs

fixes #4473

* fix: install xonsh

* fix: doc action

* chore: support *.md for documentation

* fix: remove hardcoded docs link

it affects local testing

* refactor: move sphinx extensions to its own package

* fix: remove deprecated get_theme_dir

As of Sphinx 1.2, this is passed to Sphinx via a ``setup.py`` entry
point,
and no longer needs to be included in your documentation's
``conf.py``.

* feat: jinja2 render without affecting incremental build

* style:

* feat: auto generate API doc

no need to create a file for each module

* chore: watch top-level and nested files

* refactor: update lib api-docs as well

* fix: import errors when doc generated

for some modules

* fix: relative path

* feat: add release handling

* Update .github/workflows/docs.yml

Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com>

* refactor: use github-app-token

* chore: deploy docs only when merged

Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com>
2022-01-18 11:38:27 -05:00
Noorhteen Raja NJ
d5c6c9e4e6
docs: remove xompletions api doc (#4479) 2021-11-27 09:59:23 -05:00
Daniel Shimon
099d301fae
Update completers tutorial (#4307)
* docs: completions: Improve RichCompletion and CompletionContext api docs

* docs: completers: Update tutorial

* completers: tools: Print non-default values in RichCompletion's __repr__

* completers: Add $XONSH_TRACE_COMPLETIONS variable

* news: Add update-completers-tutorial
2021-06-05 19:12:58 +03:00
Noorhteen Raja NJ
a083d28461
Completer py api (#4018)
* feat: add index to sqlite-history table

* feat: support style argument to RichCompletion object

this will enable setting style for ptk completers

* feat: add xonsh cli/argparser utils

* feat: add python api for adding/removing completers

fixes #3972

* fix: mypy error

* docs: add api doc

* fix: circular imports

* docs:

* fix: testing get-doc cross-platform

* Update xonsh/completers/_aliases.py

Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com>

* Update xonsh/completers/_aliases.py

Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com>

* style: convert % to f-strings

Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com>

Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com>
2020-12-16 14:26:22 -05:00
Noortheen Raja
d367ed2361 docs: update xontribs tutorial 2020-11-11 00:13:36 +05:30
Noortheen Raja
2b947e9e66 refactor: replace xontribs.json with xontribs_meta.py
closes #3931
2020-11-10 22:12:27 +05:30
Anthony Scopatz
3afd5430a0
Procs Initial Refactor (#3897)
* refectored builtins

* refectored posix and readers

* refectored posix and readers

* proxies

* pipelines

* basic procs import cleanup

* fixed / refactored tests

* procs docs

* amalgamate

* XONSH_DEBUG=1 in tests

* exclude xonsh.procs mypy

* Use `pip install` instead of `python setup.py install`

* Update docs/api/procs/pipelines.rst

Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com>

Co-authored-by: Gil Forsyth <gil@forsyth.dev>
Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com>
2020-10-20 10:21:11 -04:00
Noortheen Raja
9b68407d79 docs: add api-docs for ptk_shell.updator module 2020-09-30 13:11:50 +05:30
Anthony Scopatz
40e3f496e3
Update formatter.rst 2020-09-29 17:30:25 -07:00
Noortheen Raja
3c2f9b5a38 feat: use threads to offload prompt sections
resolves #2803

- update1: handle optional prompts correctly
- update2: split PromptFormatter._format_prompt
- update3: get number of workers from env
- update4: now it supports setting async prompt after initing the
session
- update5: keep track of futures<->token index to avoice looping over
all token items

refactor: cache thread results between calls

if there is not much update between calls, then it will not glitch

also applied code review suggestions

refactor: clean old running features

refactor: async-prompt handle clearing futures from container

refactor: add more docstrings and apply review changes

docs: add doc hook

refactor: change %s to string concat

docs: update title in formatter api doc

feat: style cached result as faded

refactor: update shell functions after osc_ascii PR merged

refactor: split code into updator.py to handle async updates
2020-09-27 21:53:53 +05:30
David Dotson
a8d4a57f01
Environment variable registration, deregistration (addresses #3227) (#3377)
* First attempt at register/deregister machinery for envvars

* Added detailed docstring, simplified ensurers

Also added some type checking that became clear from docstring writing.

* Changes in response to @scopatz review

Simplified kwarg names.

* defaultval -> default

* Created new Var namedtuple, as well as DEFAULT_VARS

We should now delete DEFAULT_ENSURERS, DEFAULT_VALUES, DEFAULT_DOCS, and
refactor Env to use the new single namedtuple and the DEFAULT_VARS dict

* Removed DEFAULT_ENSURERS, DEFAULT_VALUES, DEFAULT_DOCS

Now need to edit Env to use new DEFAULT_VARS, Var namedtuple

* Finished updating Env object to use new combined Var

Also made corresponding changes elsewhere ensurer was used

* Working on test failures

* More fixes in light of test failures

* Set default values for Var in register.

There's a bit of duplication here, but makes for a cleaner function.

* Black reformatting on environ.py

* Removed history replay

* Added register tests

* Added addtional deregistration test

* Removed all replay references, in docs too

* Added news item for env-reg-dereg

* trigger rebuild

* doc fix

* more doc fixes

* again

* attr names

* reorder imports

* fix flake error

Co-authored-by: Anthony Scopatz <scopatz@gmail.com>
2020-08-05 10:39:11 -04:00
Bob Hyman
53bfe8c99c
Add ptk3 (#3521)
* delete package ptk; rename ptk2 to ptk_shell.; leave ptk2 as alias for ptk_shell.
* SHELL_TYPE "prompt_toolkit" only; remove ptk1 specific behavior.
* Doc updates: eliminate reference to prompt-toolkit < 2.0
* update requirements files ptk>=2; test shell_style="none"
* fix ptk2 stub per code review
* Add ptk2 to list of packages to install.
2020-04-18 10:44:27 -04:00
Christopher J. Wright
91acb56484 add docs 2019-09-09 21:04:32 -04:00
Jan Chren
a5e3fcc28a
fix typo 2019-08-06 16:38:28 +00:00
Anthony Scopatz
7a3f7fb551 dumb terminal support 2018-12-13 16:02:59 -05:00
Anthony Scopatz
cb6a913cab docs build 2018-08-31 08:05:39 -05:00
Anthony Scopatz
abd568fccc add the jupyter_shell to the index 2018-08-02 23:49:55 -04:00
Anthony Scopatz
9bbbf07bde have jupyter streaming output 2018-08-02 18:08:44 -04:00
Anthony Scopatz
3a31d6ff31 some doc fixes 2018-07-19 19:59:07 -04:00
Anthony Scopatz
d77b25dde3 docs 2018-07-16 12:19:17 -04:00
Samuel Dion-Girardeau
38d30110f2 Fix typo in Execer page title
compiliation -> compilation

(See http://xon.sh/api/execer.html)
2018-01-13 14:24:46 -05:00
Andrew Hundt
9557950cc4 Greatly improved webpage layout so it is easier to find what you need. (#2477) 2017-08-13 21:48:26 -04:00
Gil Forsyth
8cf38e8e42 rename jsonutils so sphinx sees it 2017-02-28 15:13:30 -05:00
Anthony Scopatz
11da7fe12a New JSON utils module 2017-02-26 15:42:36 -05:00
Anthony Scopatz
184a17aea5 added news and docs 2017-02-21 00:15:34 -05:00
Anthony Scopatz
3740716799 audodoc hooks 2017-02-12 18:36:50 -05:00
Anthony Scopatz
77e8b10f07 more doc fixes 2016-12-20 13:47:58 -08:00
Anthony Scopatz
25cf37a090 Merge pull request #2018 from xonsh/xompletions
Xompletions
2016-12-16 10:37:19 -08:00
Gil Forsyth
4a4076a0c2 add xompletions to api docs 2016-12-16 11:22:23 -05:00
Hugo Wang
a3027d020b updated docs/api/history/ 2016-12-17 00:06:03 +08:00
Gil Forsyth
88bd04e5af remove defunct teepty docs 2016-10-25 10:53:59 -04:00
Jamie Bliss
78af6446fa Fix docs 2016-10-02 11:12:01 -04:00
BlahGeek
5584bc3ea8 more documentation 2016-09-05 08:27:31 +08:00
BlahGeek
e1008e8202 api docs for prompt 2016-09-04 19:59:48 +08:00
Jamie Bliss
8e537aaa05 Typo 2016-08-27 23:16:11 -04:00
Jamie Bliss
d14a4bf938 Add module API docs 2016-08-27 23:00:50 -04:00
Jamie Bliss
19b483ded5 Some corrections to vox-related documentation 2016-07-21 00:44:10 -04:00
Anthony Scopatz
967424809b some minor doc fixes 2016-07-20 21:27:17 -04:00
Jamie Bliss
50f34fa352 Refactor machinery into voxapi in order to minimize global namespace pollution. 2016-07-20 16:22:23 -04:00
Jamie Bliss
70c54e6e89 Update documentation 2016-07-20 15:58:38 -04:00
Anthony Scopatz
b8ac2a1ff0 more doc hooks 2016-06-25 12:52:05 -04:00
Anthony Scopatz
3fd1e93d3b more docs 2016-06-25 12:50:57 -04:00
Anthony Scopatz
3d91066145 minor doc fixes 2016-06-24 14:20:37 -04:00
Burak Yigit Kaya
b2f7ebb58c Add stub docs for the new commands_cache module 2016-06-24 20:27:28 +03:00
Anthony Scopatz
d14292cb9c some doc fixes 2016-06-18 17:32:37 -04:00