Skip to content

Commit

Permalink
Deploying to gh-pages from @ 6951e02 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
CAM-Gerlach committed Aug 9, 2024
1 parent b641d47 commit 171f09e
Show file tree
Hide file tree
Showing 193 changed files with 47,734 additions and 61,532 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 45b5230784e5d2f786047b47b9f6f233
tags: 645f666f9bcd5a90fca523b33c5a78b7
56 changes: 26 additions & 30 deletions 5/_sources/faq.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installing and updating
=======================

.. dropdown:: Q: How do I install Spyder?
:container: + dropdown-id-install-spyder
:name: install-spyder

The easiest way to install Spyder is with the Anaconda Python distribution, which comes with everything you need to get started in an all-in-one package.
Download it from its `webpage`_.
Expand All @@ -18,7 +18,7 @@ Installing and updating


.. dropdown:: Q: How do I install Spyder on Windows Subsystem for Linux 2 (WSL2)?
:container: + dropdown-id-install-wsl2
:name: install-wsl2

If you already installed Spyder on your Windows machine, you do not need to reinstall it on a WSL2-based Linux environment if your code must run there.

Expand Down Expand Up @@ -47,7 +47,7 @@ Installing and updating


.. dropdown:: Q: How do I update Spyder using conda?
:container: + dropdown-id-update-conda
:name: update-conda

From the command line (or Anaconda prompt on Windows), run:

Expand All @@ -64,7 +64,7 @@ Installing and updating
.. dropdown:: Q: How do update I Spyder using Anaconda Navigator?
:container: + dropdown-id-update-navigator
:name: update-navigator

Open the "gear" menu in Spyder's section under :guilabel:`Home` in Navigator.
Go to :guilabel:`Install specific version` and select the version of Spyder you want to use.
Expand All @@ -80,7 +80,7 @@ Running Spyder
==============

.. dropdown:: Q: How do I run Spyder?
:container: + dropdown-id-run-spyder
:name: run-spyder

You can launch it in any of the following ways:

Expand All @@ -98,7 +98,7 @@ Running Spyder


.. dropdown:: Q: Can I try Spyder without installing it?
:container: + dropdown-id-run-binder
:name: run-binder

Yes!
With `Binder`_, you can work with a fully functional copy of Spyder that runs right in your web browser.
Expand All @@ -109,7 +109,7 @@ Running Spyder


.. dropdown:: Q: What are the system requirements for Spyder? How resource-intensive is it?
:container: + dropdown-id-run-system-reqs
:name: run-system-reqs

Spyder works on modern versions of Windows, macOS and Linux (see the table below for recommended versions) via Anaconda, as well as other methods.
It typically uses relatively minimal CPU when idle, and 0.5 GB - 1 GB of RAM, depending on how long you've been using it and how many files, projects, panes and consoles you have open.
Expand All @@ -128,7 +128,7 @@ Running Spyder


.. dropdown:: Q: How do I run Spyder installed in a conda environment using Anaconda Navigator?
:container: + dropdown-id-run-navigator
:name: run-navigator

Select the environment you want to launch Spyder from under :guilabel:`Applications on`.
If Spyder is installed in this environment, you will see it in Navigator's :guilabel:`Home` window.
Expand All @@ -139,7 +139,7 @@ Running Spyder


.. dropdown:: Q: How do I run Spyder installed in a conda environment using the command line?
:container: + dropdown-id-run-terminal
:name: run-terminal

Activate your conda environment by typing the following in your terminal (or Anaconda Prompt on Windows):

Expand All @@ -158,7 +158,7 @@ Using Spyder
============

.. dropdown:: Q: How do I install Python packages to use within Spyder if I installed Spyder with conda?
:container: + dropdown-id-using-install-packages
:name: using-install-packages

The first approach for installing a package should be using conda.
In your system terminal (or Anaconda Prompt on Windows), type:
Expand All @@ -176,10 +176,8 @@ Using Spyder
:start: 306


.. _using-existing-environment:

.. dropdown:: Q: How do I get Spyder to work with my existing Python packages/environment?
:container: + dropdown-id-using-existing-environment
:name: using-existing-environment

To work with an existing environment in Spyder, change the default Python interpreter for new :doc:`/panes/ipythonconsole`\s to point to this environment.

Expand Down Expand Up @@ -208,10 +206,8 @@ Using Spyder
Execute the given command in your terminal (the Anaconda Prompt on Windows) with the environment activated, and finally restart the kernel once more.


.. _using-packages-installer:

.. dropdown:: Q: How do I install Python packages to use within Spyder if I downloaded Spyder from the standalone installers?
:container: + dropdown-id-using-packages-installer
:name: using-packages-installer

Watch our video on using additional packages or follow the instructions below.

Expand All @@ -237,7 +233,7 @@ Using Spyder


.. dropdown:: Q: How do I reset Spyder's preferences to the defaults?
:container: + dropdown-id-using-reset-prefs
:name: using-reset-prefs

Either use the :guilabel:`Reset Spyder to factory defaults` under :guilabel:`Tools` in Spyder's menu bar, the :guilabel:`Reset Spyder settings` Start menu shortcut (Windows), or run ``spyder --reset`` in your system terminal (Anaconda prompt on Windows).

Expand All @@ -246,7 +242,7 @@ Using Spyder


.. dropdown:: Q: How do I change Spyder's language?
:container: + dropdown-id-using-change-language
:name: using-change-language

Under :guilabel:`General` in Spyder's :guilabel:`Preferences`, go to the :guilabel:`Advanced settings` tab and select your language from the options displayed under :guilabel:`Language`.

Expand All @@ -255,7 +251,7 @@ Using Spyder


.. dropdown:: Q: How do I use code cells in Spyder?
:container: + dropdown-id-using-code-cells
:name: using-code-cells

To create a cell in Spyder's :doc:`/panes/editor`, type ``#%%`` in your script.
Each ``#%%`` will make a new cell.
Expand All @@ -266,7 +262,7 @@ Using Spyder


.. dropdown:: Q: How do I use plugins with Spyder (e.g. Spyder-Notebook, Spyder-Terminal, Spyder-Unittest)?
:container: + dropdown-id-using-plugins
:name: using-plugins

Spyder plugins are available in the ``conda-forge`` conda channel.
To install one, type on the command line (or Anaconda Prompt on Windows):
Expand All @@ -292,7 +288,7 @@ Using Spyder


.. dropdown:: Q: How do I clear all variables before executing my code?
:container: + dropdown-id-using-clear-variables
:name: using-clear-variables

Check the option :guilabel:`Remove all variables before execution` in the :guilabel:`Configuration per file...` dialog under the :guilabel:`Run` menu.

Expand All @@ -301,7 +297,7 @@ Using Spyder


.. dropdown:: Q: How do I run my code in a dedicated console or an external system terminal?
:container: + dropdown-id-using-dedicated-console
:name: using-dedicated-console

Select the appropriate option in the :guilabel:`Configuration per file...` dialog under the :guilabel:`Run` menu.

Expand All @@ -310,7 +306,7 @@ Using Spyder


.. dropdown:: Q: How do I change the syntax highlighting theme in the Editor?
:container: + dropdown-id-using-syntax-theme
:name: using-syntax-theme

Go to :guilabel:`Preferences` and select the theme you want under :guilabel:`Syntax highlighting theme` in the :guilabel:`Appearance` section.

Expand All @@ -324,14 +320,14 @@ Troubleshooting
===============

.. dropdown:: Q: I've found a bug or issue with Spyder. What do I do?
:container: + dropdown-id-troubleshooting-spyder
:name: troubleshooting-spyder

You should first follow the steps in our :doc:`troubleshooting guide</troubleshooting/first-steps>`.
If you can't solve your problem, open an issue by following the instructions in our :doc:`/troubleshooting/submit-a-report` section.


.. dropdown:: Q: I get an error in the IPython console running my code! Help!
:container: + dropdown-id-troubleshooting-running-code
:name: troubleshooting-running-code

First, make sure the error you are seeing is not a bug in your code.
To confirm this, try running it in any standard Python interpreter.
Expand All @@ -342,7 +338,7 @@ Troubleshooting


.. dropdown:: Q: Code completion/help doesn't work; what can I do?
:container: + dropdown-id-troubleshooting-completion
:name: troubleshooting-completion

If nothing is displayed in the calltip, hover hint or :doc:`/panes/help` pane, make sure the object you are inspecting has a docstring, and try executing your code in the :doc:`/panes/ipythonconsole` to get help and completions there.
If this doesn't work, try restarting PyLS by right-clicking the :guilabel:`LSP Python` label item in the statusbar at the bottom of Spyder's main window, and selecting the :guilabel:`Restart Python Language Server` option.
Expand All @@ -351,7 +347,7 @@ Troubleshooting


.. dropdown:: Q: I get the message "An error occurred while starting the kernel". How do I fix this?
:container: + dropdown-id-troubleshooting-starting-kernel
:name: troubleshooting-starting-kernel

First, make sure your version of Spyder-Kernels is compatible with that of Spyder.
See the table in the :ref:`spyder-kernels-version-ref` section of the troubleshooting guide to check.
Expand All @@ -366,7 +362,7 @@ Troubleshooting


.. dropdown:: Q: Spyder doesn't launch or is slow on macOS Big Sur. How can I get it working?
:container: + dropdown-id-troubleshooting-macos-bigsur
:name: troubleshooting-macos-bigsur

Spyder is in the final stages of being updated for full compatibility with macOS 11 Big Sur, which will be released by the end of 2020 as part of version 4.2.1.
However, you can get it working right now with the workaround below.
Expand All @@ -393,7 +389,7 @@ About Spyder
============

.. dropdown:: Q: What's Spyder's licensing situation? Is commercial use allowed?
:container: + dropdown-id-commercial-use
:name: commercial-use

Spyder is 100% free and open source; there is no paid version or prohibition on commercial use.
It is developed by its international user community, and supported by its users through `OpenCollective`_ and by its generous sponsoring organizations, including `Quansight`_ and `NumFOCUS`_.
Expand All @@ -407,7 +403,7 @@ About Spyder


.. dropdown:: Q: What do the Anaconda licensing changes mean for Spyder?
:container: + dropdown-id-anaconda-license
:name: anaconda-license

If you use Spyder with the Anaconda distribution, they `recently changed`_ their `Terms of Service`_ to add restrictions on large (> 200 employee) for-profit companies using Anaconda on a large scale.
However, these terms only apply to the package infrastructure (the full Anaconda distribution and the ``defaults`` conda channel).
Expand Down
85 changes: 50 additions & 35 deletions 5/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,57 +20,73 @@ Where to go now?
Spyder's documentation provides a variety of resources that will help you learn how to use the application and explore each one of its panes.
These include video tutorials, in-depth descriptions and how-to guides covering a wide range of needs and experience levels with Spyder.

.. panels::
:container: container-lg pb-3 px-md-0 px-5
:column: col-lg-4 col-md-6 col-sm-6 col-xs-12 p-2
.. grid:: 1 2 3 3
:gutter: 3

.. div:: align-center
.. grid-item-card::

.. rst-class:: fasb fa-book-open
.. div:: align-center

.. div:: align-center
.. rst-class:: fasb fa-book-open

If you are looking for a summary of its features and interface, check out the :doc:`quickstart`.
---
.. div:: align-center
.. div:: align-center

.. rst-class:: fasb fa-download
If you are looking for a summary of its features and interface, check out the :doc:`quickstart`.

.. div:: align-center

If you don't have Spyder installed and want to get started, follow the :doc:`/installation`.
---
.. div:: align-center
.. grid-item-card::

.. rst-class:: fasb fa-walking
.. div:: align-center

.. div:: align-center
.. rst-class:: fasb fa-download

If you are completely new to Spyder, watch our basic tutorial series, :doc:`videos/first-steps-with-spyder`.
---
.. div:: align-center
.. div:: align-center

.. rst-class:: fasb fa-columns
If you don't have Spyder installed and want to get started, follow the :doc:`/installation`.

.. div:: align-center

If you are familiar with Spyder and want to explore the functionality of its panes in more detail, go to :doc:`panes/index`.
---
.. div:: align-center
.. grid-item-card::

.. rst-class:: fasb fa-first-aid
.. div:: align-center

.. div:: align-center
.. rst-class:: fasb fa-walking

If you've run into a Spyder problem and need help solving it, take a look at our :doc:`troubleshooting guide<troubleshooting/first-steps>`.
---
.. div:: align-center
.. div:: align-center

.. rst-class:: fasb fa-question-circle
If you are completely new to Spyder, watch our basic tutorial series, :doc:`videos/first-steps-with-spyder`.

.. div:: align-center

If you have a question about Spyder, visit the :doc:`faq` section.
.. grid-item-card::

.. div:: align-center

.. rst-class:: fasb fa-columns

.. div:: align-center

If you are familiar with Spyder and want to explore the functionality of its panes in more detail, go to :doc:`panes/index`.


.. grid-item-card::

.. div:: align-center

.. rst-class:: fasb fa-first-aid

.. div:: align-center

If you've run into a Spyder problem and need help solving it, take a look at our :doc:`troubleshooting guide<troubleshooting/first-steps>`.


.. grid-item-card::

.. div:: align-center

.. rst-class:: fasb fa-question-circle

.. div:: align-center

If you have a question about Spyder, visit the :doc:`faq` section.



Expand Down Expand Up @@ -138,12 +154,11 @@ Connect with Spyder through our social media channels to stay up to date with ou
:maxdepth: 2
:hidden:

Welcome<self>
quickstart
installation
FAQ<faq>
videos/index
panes/index
plugins/index
troubleshooting/index
workshops/index
FAQ<faq>
troubleshooting/index
6 changes: 3 additions & 3 deletions 5/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _install-guide:

##################
Installation Guide
##################
#############
Install Guide
#############

Spyder is relatively easy to install on Windows, Linux and macOS.
Just make sure to read and follow these instructions with care.
Expand Down
6 changes: 3 additions & 3 deletions 5/_sources/panes/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
==============
Panes in Depth
==============
=====
Panes
=====

.. toctree::
:maxdepth: 2
Expand Down
6 changes: 3 additions & 3 deletions 5/_sources/plugins/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
==============
Spyder Plugins
==============
=======
Plugins
=======

.. toctree::
:maxdepth: 2
Expand Down
Loading

0 comments on commit 171f09e

Please sign in to comment.