Skip to content

Latest commit

 

History

History
74 lines (43 loc) · 3.91 KB

README.md

File metadata and controls

74 lines (43 loc) · 3.91 KB

Spyder Documentation

Spyder Docs - Documentation for the Scientific Python Development Environment

Copyright (c) 2009- Spyder Doc Contributors and others (see AUTHORS.txt)

License Build Check Lint Netlify Status pre-commit Nox OpenCollective Backers

Screenshot of documentation index page

Overview

This repository contains the documentation for Spyder, the Scientific Python Development Environment. You can view the live docs for current and past Spyder versions at docs.spyder-ide.org.

For more information about Spyder itself, please see our website and the main repo.

Building and Deploying

The docs are built with Sphinx and deployed with GitHub Actions to the docs.spyder-ide.org domain. Nox is used to automate setup, building and numerous other project tasks. The master branch contains the in-development docs for Spyder 5, while the frozen 4.x and 3.x branches retain the docs for Spyder 4 and Spyder 3.

Contributing

We welcome your contributions of corrections, additions and enhancements to these docs, as they are very much a work in progress, and we appreciate getting our broad community involved wherever possible. Its easy to build a local copy in one or two steps with Nox, or you can also just check your changes with our live build previews on PRs. Simply submit a PR with your changes and we'll be happy to review it; make sure to read our Contributing Guide in mind to ensure the process of getting your revisions integrated goes smoothly.

Thanks for your interest in Spyder and its documentation, and we appreciate your support of the project!

More information

Main Website

Online Documentation

Spyder GitHub

Development Wiki

Google Group

@Spyder_IDE on Twitter

@SpyderIDE on Facebook

Support Spyder on OpenCollective