Skip to content

spyder-ide/spyder-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Spyder API Docs

Banner image with the Spyder wordmark and full name, the Scientific Python Development Environment

Copyright (c) 2020- Spyder-API-Docs Contributors and others (see AUTHORS.txt)

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

Overview

This repository contains the developer and API documentation for Spyder, the Scientific Python Development Environment. You can view the live dev docs for current and past Spyder versions at Spyder-IDE.GitHub.io/Spyder-API-Docs.

For Spyder's user documentation, visit the spyder-ide/spyder-docs repository or the deployed documentation at docs.spyder-ide.org. For more information about Spyder itself, please see our website and the main repo.

Building and Running

This project uses Nox to help automate setting up an environment, building and running, linting the codebase, and many other development tasks. To build it, ensure Nox is installed (via pip, Conda, pipx, etc), and then just run

nox -s build

For more details and step by step instructions, see our Contributing Guide.

Contributing

We welcome your contributions of issue reports, fixes and enhancements to Spyder-API-Docs, as it is by and for the community, and we appreciate others getting involved. Its easy to build a local copy in one or two steps with Nox, or you can also just check your changes with our automated CI jobs on PRs. Just submit a PR with your changes and we'll be happy to review it; make sure to read our Contributing Guide first to ensure the process of getting your revisions integrated goes smoothly.

Thanks for your interest in Spyder-API-Docs, and we appreciate your support of the project!

More Information

Main Website

Online Documentation

Spyder GitHub

Spyder Google Group

@Spyder_IDE on Twitter

@Spyder on Fosstodon

@SpyderIDE on Facebook

Support Spyder on OpenCollective