Commit graph

74 commits

Author SHA1 Message Date
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
Anthony Scopatz
456167f70e even more docs 2016-06-05 22:41:56 -04:00
Anthony Scopatz
231c7f0a6e add completer API doc hooks 2016-06-04 20:05:55 -04:00
Anthony Scopatz
c8249a033b minor doc updates 2016-05-28 19:13:06 -04:00
Frank Sachsenheim
6d9cb94347 Adds xonsh.platform.scandir 2016-05-24 20:49:46 +02:00
Frank Sachsenheim
e7ee0f33e5 Adds docs for xonsh.platform 2016-05-24 20:49:46 +02:00
Frank Sachsenheim
81f0f50496 Adds a xonsh.platform module
comes with occasional code cleanup and micro optimizations
fixes `xonsh.tools.CommandCache.all_commands`
2016-05-20 19:26:02 +02:00
Frank Sachsenheim
05bad9af2a Updates to docs
- more links to numpydoc guide
- clarifies dependencies to build docs
2016-05-16 12:42:02 +02:00
adam j hartz
a2285fd916 documentation 2016-05-12 11:53:15 -04:00
Anthony Scopatz
50d8f0c5bd interim add 2016-05-11 00:42:36 -04:00
Gil Forsyth
527b6e9d0e add vox to API index 2016-04-06 18:42:55 -04:00
Konstantin Molchanov
84b0973080 Docs: API docs for Vox added. 2016-02-13 21:49:24 +03:00
Anthony Scopatz
5785c9c86e added tracer mod 2016-02-05 01:45:05 -05:00
Anthony Scopatz
2f925aa3f1 autogen config var docs 2016-01-06 01:55:40 -08:00
Anthony Scopatz
6769534856 docs update 2015-12-30 00:23:22 -08:00
Anthony Scopatz
25cc8fb845 fixed minor conflict 2015-11-06 19:12:33 -05:00