Skip to content

Commit

Permalink
Document registration for spyder.
Browse files Browse the repository at this point in the history
  • Loading branch information
anntzer committed Apr 27, 2024
1 parent 280ed10 commit b11162d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 4 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ Then, append the output of ``python -m ipython_autoimport`` to the
locate`` (typically ``~/.ipython/profile_default/``). If you don't have such a
file at all, first create it with ``ipython profile create``.

When using Spyder, the above registration method will not work; instead, add
``%load_ext ipython_autoimport`` to the :menuselection:`Preferences --> IPython
console --> Startup --> Run code` option.

Note that upon loading, ``ipython_autoimport`` will register its submodule
auto-importer to IPython's "limited evalutation" completer policy (on IPython
versions that support it).
Expand Down
4 changes: 2 additions & 2 deletions src/ipython_autoimport.py
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,8 @@ def unload_ipython_extension(ipython):
if __name__ == "__main__":
if os.isatty(sys.stdout.fileno()):
print("""\
# Please append the output of this command to the
# output of `ipython profile locate` (typically
# Please append the output of this command to the config file in
# the directory specified by `ipython profile locate` (typically
# `~/.ipython/profile_default/ipython_config.py`)
""")
print("""\
Expand Down

0 comments on commit b11162d

Please sign in to comment.