Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
283ceca
Remove mostly-obselete and unmaintained CSSlint linter
CAM-Gerlach Nov 3, 2023
b253bba
Sync pre-commit hooks and config from website as of 2023-11-01
CAM-Gerlach Nov 3, 2023
6156c48
Remove deprecated Stylelint style rules
CAM-Gerlach Oct 27, 2023
dbcc854
Add Prettier to pre-commit hooks to replace stylelint for CSS
CAM-Gerlach Oct 27, 2023
3119f90
Add Pretter formatting to JS with loosened config matching current
CAM-Gerlach Oct 27, 2023
eb42dd1
Apply standard strict Prettier config
CAM-Gerlach Oct 27, 2023
81b10f8
Remove no-longer-needed Netlify runtime.txt to ease upgrades
CAM-Gerlach Nov 3, 2023
5ac038d
Update CI workflows and config, and sync with website
CAM-Gerlach Nov 4, 2023
bbf20cf
Add flaky OpenSUSE URL to linkcheck ignore list
CAM-Gerlach Nov 7, 2023
38420fe
Update meta-files and sync with other repos
CAM-Gerlach Nov 7, 2023
09a94f0
Update docs-specific hooks and config as of 2024-01-29
CAM-Gerlach Jan 29, 2024
0d5d2fd
Add upper caps to fix sphinxcontrib deps dropping Sphinx<5 compat
CAM-Gerlach Jan 29, 2024
1a7520e
Fix additional broken links in docs as of 2024-01-29
CAM-Gerlach Jan 29, 2024
678f4e9
Upgrade infra, CIs and pre-commit checks & sync with website (#355)
CAM-Gerlach Jan 29, 2024
a509747
Add/update links to separate M1 and Intel macOS installers (#359)
CAM-Gerlach Feb 14, 2024
476fb2d
Silence linkcheck failures due to SO/SE blocking GHA
CAM-Gerlach Feb 23, 2024
cf83010
Schedule linkcheck job to run weekly every Friday
CAM-Gerlach Feb 23, 2024
da485cb
Run linkcheck weekly and silences SO/SE failures due to blocking GHA …
ccordoba12 Feb 23, 2024
09ce622
Refine commands & add/update links in contributing guide (#358)
LucyJimenez Feb 26, 2024
390681b
Update troubleshooting link in install guide to internal one (#361)
CAM-Gerlach Feb 29, 2024
32efdae
Update macOS Intel install link again back to original (#363)
CAM-Gerlach Mar 27, 2024
e739e21
Update version warning banner to always point to the latest stable do…
CAM-Gerlach Jul 26, 2024
226aa9a
Adopt PyData-Sphinx-Theme for Spyder Docs
CAM-Gerlach Apr 24, 2024
986a61a
Fix new PyData-Sphinx-Theme warnings introduced in conf.py
CAM-Gerlach Apr 25, 2024
b0821ea
Port main page from Sphinx-Panels to grid Sphinx-Design replacement
CAM-Gerlach Apr 25, 2024
b922e76
Port FAQ dropdown syntax from Sphinx-Panels to Sphinx-Design
CAM-Gerlach Apr 25, 2024
8a7e762
Update div to section in CSS per PST changes
CAM-Gerlach Apr 25, 2024
0b3885d
Configure PST top bar and shorten top-level page title names
CAM-Gerlach Apr 25, 2024
0a69731
TEMP: Hack to only build current version so previews work with PST
CAM-Gerlach Apr 25, 2024
7736142
Fix logo in header, copyright in footer, & image bottom margins
CAM-Gerlach Jul 25, 2024
ac02eae
Add support for versions using the Pydata-Sphinx-Thme switcher
CAM-Gerlach Jul 25, 2024
2674376
Modify deploy to use PST switcher instead of Sphinx-Multiversion
CAM-Gerlach Aug 1, 2024
5576918
Remove cruft from old theme and simplify tour assets
CAM-Gerlach Aug 8, 2024
a430b22
Ignore more flaky links (GitHub commits and OpenTeams)
CAM-Gerlach Aug 9, 2024
e8f00a4
Adopt PyData-Sphinx-Theme for Spyder Docs (#367)
CAM-Gerlach Aug 9, 2024
6951e02
Explicitly check value of deploy vars in GHA to ensure correct logic …
CAM-Gerlach Aug 9, 2024
4edb662
Fix download links broken by the Spyder 6 release today & add Linux url
CAM-Gerlach Sep 4, 2024
27fa501
Pin caniuse in pre-commit to avoid error in stylelint plugin
CAM-Gerlach Sep 4, 2024
6767009
Move Linux install link to after macOS on Carlos' instructions
CAM-Gerlach Sep 4, 2024
5f68368
Fix download links now broken in Spyder 6 & fix error w/stylelint (#378)
ccordoba12 Sep 4, 2024
a478f38
Migrate makefiles to noxfile using Nox and add additional commands
CAM-Gerlach Sep 2, 2024
b597a3c
Update Readme and Contributing Guide to account for Nox and not Make
CAM-Gerlach Sep 3, 2024
96d850b
Update CI scripts and config to use Nox and remove old theme cruft
CAM-Gerlach Sep 2, 2024
cc05eca
Remove outdated and no longer needed makefiles and make.bat scripts
CAM-Gerlach Sep 3, 2024
76c446a
Migrate docs infrastructure from Make to Nox (#377)
CAM-Gerlach Sep 4, 2024
1655d3b
Skip Nox installation step if it has already installed Sphinx before
CAM-Gerlach Sep 6, 2024
109f51d
Improve Sphinx invocation generator to handle arbitrary builders
CAM-Gerlach Sep 6, 2024
b2ec0ed
Update Contrib Guide to clarify build section & note arg passthrough
CAM-Gerlach Sep 6, 2024
abcaeef
Fix nox -s clean so it actually works correctly & add ignore option
CAM-Gerlach Sep 6, 2024
ea3e079
Improve Nox install command to pass thru args to pip (e.g. --upgrade)
CAM-Gerlach Sep 6, 2024
22b3088
Upgrade max Sphinx support to 8 and Sphinx-Design to 0.6
CAM-Gerlach Sep 6, 2024
9ce860a
Improve and refactor noxfile to prepare for translation commands (#379)
ccordoba12 Sep 7, 2024
a22edcc
Add infra & nox commands for building & managing gettext pot/po files
CAM-Gerlach Sep 9, 2024
0d1cafe
Add multi-language infrastructure for building docs
CAM-Gerlach Sep 9, 2024
5ecc0fb
Add config file for Crowdin online translation platform
CAM-Gerlach Sep 9, 2024
a0163ab
Add initial source pot files and translated po files from Crowdin
CAM-Gerlach Sep 10, 2024
7986519
Add docs translation and the infrastructure and automation it require…
ccordoba12 Sep 12, 2024
56d5662
Remove obselete po messages & drop legacy conf.py setting
CAM-Gerlach Sep 15, 2024
c5ae9b9
Regenerate pot and po files with modern Sphinx, theme & i18n infra
CAM-Gerlach Sep 15, 2024
02b82d4
Regenerate translation files with current infra and update with new s…
CAM-Gerlach Sep 17, 2024
6e157d9
Fix Sphinx Lint-detected errors for Spanish translations (#382)
hugovk Sep 18, 2024
038d6c5
Upgrde Pre-Commit hooks and config as of 2024-09-20
CAM-Gerlach Sep 22, 2024
fe0454f
Update hook configuration with new/changed settings since last upgrade
CAM-Gerlach Sep 22, 2024
f136847
Remove lib/ directory in .gitignore that shouldn't be ignored
CAM-Gerlach Sep 22, 2024
d153e12
Update pre-commit hooks and config for 2024-09 (#383)
ccordoba12 Sep 23, 2024
bf3b5f4
Add setup and setup-remotes Nox commands
CAM-Gerlach Sep 24, 2024
947896f
Add Nox setup command to Contributing Guide and restructure accordingly
CAM-Gerlach Sep 24, 2024
9dca84e
Add docs aliases to Nox build commands for consistency/reusability
CAM-Gerlach Sep 24, 2024
23eba15
Make nox -s run emit a helpful error if no command invocation is passed
CAM-Gerlach Sep 24, 2024
32b9456
Add Nox setup & setup-remotes commands + other improvements (#384)
ccordoba12 Sep 25, 2024
df781c2
Remove unmaintained and unused curlylint from linters
CAM-Gerlach Sep 25, 2024
7b8e70b
Add Black as pre-commit hook and custom config file for it
CAM-Gerlach Sep 25, 2024
9e75d18
Blacken repository's Python scripts
CAM-Gerlach Sep 25, 2024
3ad7314
Ignore linkcheck errors for flaky figshare.com URLs
CAM-Gerlach Sep 25, 2024
c9abaf2
Pin eslint to fix dep conflict issue & update dates
CAM-Gerlach Sep 26, 2024
c173ccc
Update dependency update dates to 2024-09-25
CAM-Gerlach Sep 26, 2024
5156274
Add .git-blame-ignore-revs for Black commit & add to Nox setup
CAM-Gerlach Oct 3, 2024
28f8e03
Improve perf of setup-remotes Nox command by skipping env setup
CAM-Gerlach Oct 3, 2024
fa91f0e
Remove Curlylint, add Black and fix ESLint (#385)
ccordoba12 Oct 3, 2024
c582153
Bump PDST version range to include 0.16 after testing
CAM-Gerlach Oct 24, 2024
2c6b841
Add language switcher template and JS from PDST version switcher
CAM-Gerlach Oct 24, 2024
eeb9e7e
Implement minimal changes necessary for a second working switcher
CAM-Gerlach Oct 24, 2024
91820f2
Write new Javascript so that switcher is functional (styling aside)
CAM-Gerlach Nov 13, 2024
0e5cdd7
Patch theme CSS in Noxfile so language switcher is displayed properly
CAM-Gerlach Nov 13, 2024
eb70492
Update Spanish translations to add main page text & FAQ titles (#389)
CAM-Gerlach Nov 14, 2024
279560e
Add language switcher to the docs (#388)
ccordoba12 Nov 14, 2024
ec9d97d
Pin pydata-sphinx-theme to 0.14 (#390)
ccordoba12 Nov 19, 2024
98004cb
Fix bug in language switcher due to lack of trailing slash in base UR…
CAM-Gerlach Nov 26, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .black.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[tool.black]
line-length = 79
target-version = ["py38", "py39", "py39", "py310", "py311", "py312", "py313"]
13 changes: 10 additions & 3 deletions .browserslistrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Browsers that we support

>0.25%
last 3 versions
defaults
not IE 11
not last 0 OperaMini version
not last 0 OperaMobile version
not Android < 5
not Edge < 19
not KaiOS < 3
not OperaMini all
not OperaMobile < 13
not QQAndroid >= 0
not UCAndroid >= 0
not dead
3 changes: 2 additions & 1 deletion .codespellrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ builtin = clear,rare,informal,code,names
check-filenames =
check-hidden =
enable-colors =
ignore-words-list = sur
ignore-words-list = jupyter,lite,sur
quiet-level = 32
skip = .codespellrc,.gitattributes
46 changes: 0 additions & 46 deletions .csslintrc

This file was deleted.

14 changes: 0 additions & 14 deletions .eslintrc.json

This file was deleted.

4 changes: 3 additions & 1 deletion .flake8
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
[flake8]
ignore = E123, W504
count = True
ignore = E123, E203, W504
max-doc-length = 79
max-complexity = 15
jobs = 1
3 changes: 3 additions & 0 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Blacken scripts

9e75d1834b30a486e6b8d0a011be43b587e8cd2d
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Issue Report

<!--- **PLEASE NOTE:** This is the issue tracker for Spyder's documentation, not problems with the Spyder application itself nor general help with Spyder. For that, please see the main Spyder repo: <https://github.com/spyder-ide/spyder> . --->

<!--- Please make sure you fill out this template completely so we can find and fix your issue. Otherwise, it may be closed. Thanks! --->

# Issue Report

## Issue Description

Expand Down Expand Up @@ -35,7 +36,7 @@
* [ ] Spyder 3 (``3.x``, frozen)


* Are you planning on submitting a Github pull request with a suitable change?
* Are you planning on submitting a GitHub pull request with a suitable change?

* [ ] Yes
* [ ] No
Expand Down
3 changes: 2 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Pull Request

<!--- Before submitting your pull request, --->
<!--- please complete as much as possible of the following checklist: --->

# Pull Request

## Pull Request Checklist

Expand Down
40 changes: 29 additions & 11 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Build the docs to test that they work correctly
# Based on https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

# Build the site and deploy it to GitHub pages
name: Build

on: # yamllint disable-line rule:truthy
Expand All @@ -17,27 +15,47 @@ on: # yamllint disable-line rule:truthy
- '*.*'
- 'staging*'

permissions:
contents: write

jobs:
build:
name: Build Docs
name: Build and Deploy

runs-on: ubuntu-latest

env:
IS_DEPLOY: ${{ (github.event_name == 'push' && '1') || '0' }}
IS_STAGING: ${{ (github.ref == 'refs/heads/staging' && '1') || '0' }}
IS_MAIN: ${{ ((github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master') && '1') || '0' }}

steps:
- name: Checkout repository
uses: actions/checkout@v3
with:
fetch-depth: 0
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.9'
python-version: '3.11'
- name: Install dependencies
shell: bash
run: ./ci/install.sh
- name: List dependencies
shell: bash
run: pip list
- name: Build with Sphinx
run: |
echo $IS_DEPLOY
echo $IS_PROD
echo $IS_MAIN
pip list
- name: Build site
shell: bash
run: ./ci/build.sh
- name: Postprocess site
shell: bash
run: nox -s prepare-multiversion
- name: Deploy to GitHub Pages
if: env.IS_DEPLOY == '1'
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: ./doc/_build/html
clean: false # Don't remove files from other branches
dry-run: ${{ (env.IS_STAGING == '1' && 'true') || 'false' }}
17 changes: 11 additions & 6 deletions .github/workflows/check.yaml
Original file line number Diff line number Diff line change
@@ -1,40 +1,45 @@
# Build the docs and run checks on them
# Based on https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Check

on: # yamllint disable-line rule:truthy
schedule:
- cron: '49 18 * * 5' # 18:49 UTC every Friday, to avoid GHA load spikes

push:
branches:
- master
- main
- '*.*'
- 'staging*'

pull_request:
branches:
- master
- main
- '*.*'
- 'staging*'

workflow_dispatch: # yamllint disable-line rule:empty-values

jobs:
check:
name: Check Docs
name: Check Links

runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.9'
python-version: '3.11'
- name: Install dependencies
shell: bash
run: ./ci/install.sh
- name: List dependencies
shell: bash
run: pip list
- name: Run Linkcheck
run: make linkcheck
run: nox -s linkcheck
38 changes: 0 additions & 38 deletions .github/workflows/deploy.yaml

This file was deleted.

16 changes: 5 additions & 11 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,10 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.9'
- name: Install dependencies
shell: bash
run: ./ci/install.sh
- name: List dependencies
shell: bash
run: pip list
- name: Run Pre-Commit hooks
uses: pre-commit/action@v3.0.0
python-version: '3.11'
- name: Run pre-commit hooks
uses: pre-commit/action@v3.0.1
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ develop-eggs/
dist/
downloads/
eggs/
lib/
lib64/
MANIFEST
parts/
Expand Down
44 changes: 0 additions & 44 deletions .markdownlint.json

This file was deleted.

Loading