Commit graph

63 commits

Author SHA1 Message Date
Bob Hyman
f034d3dc06 Merge branch 'master' into is_3622 2020-08-28 23:15:03 -04:00
Anthony Scopatz
f048b295d6 black updates to tests and docs 2020-08-26 10:10:59 -05:00
Bob Hyman
a67df4fd5f Enable xonshcon blocks in docs. 2020-08-20 01:13:45 -04:00
Anthony Scopatz
fc745561cf landing page 2020-08-09 18:00:23 -05:00
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
Anthony Scopatz
0942d7b3d7 runthis 2020-03-19 23:05:18 -05:00
Morten Enemark Lund
4805f10095 Make it easier to built tutorials offline 2019-10-07 21:08:58 +02:00
Morten Enemark Lund
98a62c492c Workaround a problem with cloud_theme and sphinx2
This fixes a problem with sphinx and the cloud theme. Sphinx 2 adds <p> elements
in the tables and lists, which causes the theme to look werid.
2019-07-31 14:47:45 +02:00
Morten Enemark Lund
4c639beb89 Black formatting 2019-07-31 12:58:00 +02:00
Morten Enemark Lund
22bb5718ae Fix admonitions with sphinx 2.0 2019-07-31 12:55:17 +02:00
Anthony Scopatz
0b58eed37f doc fixes 2018-09-13 17:26:37 -04:00
Anthony Scopatz
0f00519d16 some more docfix bugs 2018-09-13 17:16:37 -04:00
Anthony Scopatz
6028bdfb95 fix sphinx conf import for ptk 2018-07-16 10:06:41 -04:00
Morten Enemark Lund
2ee57ce2b8 Update xontrib description
Installation instructions are now hidden if the
xontrib is preinstalled with xonsh. Also adds a 'Usage'
section on how to enable the xontrib.
2018-04-25 11:11:21 +02:00
Morten Enemark Lund
a036149be8 More fixes for building docs on Windows 2018-04-25 11:09:47 +02:00
Andrew Hundt
fce093fd3b reverse build changes for travis 2017-08-15 13:10:20 -04:00
Andrew Hundt
80a43d8697 return to cloud_sptheme so new PR only has layout improvements 2017-08-15 11:16:05 -04:00
Andrew Hundt
3fb8131cb7 ascii_conch_part_transparent_tight.png added and enabled in sphinx conf.py 2017-08-14 17:02:32 -04: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
bc7d4117e9 don't require prompt toolkit for docs on user side
we'll make sure it's available on CI when the docs are generated for the
website, but it shouldn't fail to build in userspace just because of the
ptk events hack thing
2017-02-28 15:17:43 -05:00
Gil Forsyth
91653dafa8 import events via ptk shell to gather all events
Not the prettiest thing but if we don't import the events via the PTK
shell then ``on_ptk_create`` doesn't get picked up during doc generation
2017-02-28 15:13:47 -05:00
Gil Forsyth
582d9abf23 fix incorrect eventsbody generation in conf.py 2016-12-16 11:22:32 -05:00
Gil Forsyth
45670f1dd6 import xonsh.main to fix events docs generation
sphinx will implicitly import main, but not before we call
`make_events()`, so only `on_chdir` shows up on the events listing.
explicitly importing `xonsh.main` fixes this up so all of the available
events are documented properly.
2016-12-01 12:41:19 -05:00
Matthias Bussonnier
c0d584d7a3 Hack a rel=canonical in the templates.
We do not want non-canonical versions of xonsh docs to be indexed. OR at
least they should point to the canonical version.

Technically we should even try to have the stable version under a
/stable/ url (to leave us with some freedom of changing things) So that
later we can replace stable with X.y and have a version switcher.
2016-10-30 12:27:40 -07:00
Gil Forsyth
8a5dfcf3a7 add xonshcon lexer to sphinx conf 2016-10-25 10:53:30 -04:00
Matthias Bussonnier
e67c448290 Build docs on 3.5 otherwise we'll never caught failures. 2016-09-17 13:20:17 -07:00
Matthias Bussonnier
1dbfb41499 Define __xonsh_commands_cache__ during doc builds. 2016-09-08 13:56:31 -07:00
Jamie Bliss
ce61c59d4b Do some fixed-width formatting 2016-08-27 22:29:11 -04:00
Jamie Bliss
3721204304 Add an autogenerated events listing 2016-08-27 22:25:29 -04:00
Anthony Scopatz
cd468a45ce 3 to 5 col 2016-07-20 21:41:29 -04:00
Anthony Scopatz
9b054c9ba2 docs fix 2016-07-20 21:39:00 -04:00
Anthony Scopatz
d14292cb9c some doc fixes 2016-06-18 17:32:37 -04:00
Anthony Scopatz
231c7f0a6e add completer API doc hooks 2016-06-04 20:05:55 -04:00
Frank Sachsenheim
38a65f755e Use a common prefix in doc's modindex 2016-05-24 20:49:46 +02:00
Anthony Scopatz
362a098d84 added store_as_str to vardocs 2016-05-21 15:03:27 -04:00
Anthony Scopatz
4a6e153396 doc fixes 2016-05-20 17:58:50 -04:00
Anthony Scopatz
ab47bfd5bd autogen xontrib docs 2016-05-11 00:57:48 -04:00
Anthony Scopatz
50d8f0c5bd interim add 2016-05-11 00:42:36 -04:00
Anthony Scopatz
83a93c40a8 alias usage hooks 2016-02-05 01:25:59 -05:00
Anthony Scopatz
46a136c58e initial cmdhelp 2016-02-05 00:42:05 -05:00
Anthony Scopatz
2f925aa3f1 autogen config var docs 2016-01-06 01:55:40 -08:00
Anthony Scopatz
caa664e252 more minor changes 2015-09-13 18:23:00 -04:00
Anthony Scopatz
5e56a0bb09 some more conf changes 2015-09-13 18:17:26 -04:00
Anthony Scopatz
d047939453 some image fixes 2015-09-13 18:09:11 -04:00
Anthony Scopatz
1775725246 more release notes 2015-09-13 17:59:24 -04:00
Klaus Alexander Seistrup
ee65f492f2 Removed trailing whitespace 2015-07-29 23:58:25 +02:00
Aaron Griffin
74ce8ba781 Removed extra lines 2015-04-07 08:06:23 -07:00
Aaron Griffin
d2be629b48 Merge branch 'master' of github.com:aig787/xonsh 2015-04-07 08:04:21 -07:00
Aaron Griffin
e5848d713c
Fixed missing options for custom theme 2015-04-06 12:50:57 -07:00