Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modernize docs #936

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

Nothing4You
Copy link
Collaborator

@Nothing4You Nothing4You commented Jun 11, 2023

What do these changes do?

  • use Python 3.11 for RTD build
  • modernize build scripts by newly generating them with Sphinx 7 quickstart
  • remove sphinxcontrib.asyncio extension, as it doesn't support Sphinx 6+ and we're not using any of its features anyway
  • add sphinx_copybutton extension to make it easy to copy code snippets
  • remove unused and broken (redirected to 2.0) SQLAlchemy intersphinx mapping
  • switch to furo theme, which features a number of improvements, including Sphinx 7 compatibility
  • fix examples/example_sa.py include in docs after it was renamed in 958fd0b
  • fail RTD build if docs build generates warnings

This also depends on dropping Python 3.7, as Sphinx 3.6 dropped Python 3.7.

Are there changes in behavior for the user?

Only documentation.

Related issue number

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • Add a new news fragment into CHANGES.txt

@Nothing4You Nothing4You added this to the 0.2 milestone Jun 11, 2023
@Nothing4You Nothing4You force-pushed the modernize-docs branch 2 times, most recently from 5942867 to a21d0ca Compare June 11, 2023 16:15
@Nothing4You Nothing4You modified the milestones: 0.2, 0.3 Jun 11, 2023
- use Python 3.11 for RTD build
- modernize build scripts by newly generating them with Sphinx 7 quickstart
- remove sphinxcontrib.asyncio extension, as it doesn't support Sphinx 6+
  and we're not using any of its features anyway
- add sphinx_copybutton extension to make it easy to copy code snippets
- remove unused and broken (redirected to 2.0) SQLAlchemy intersphinx mapping
- switch to furo theme, which features a number of improvements, including
  Sphinx 7 compatibility
- fix examples/example_sa.py include in docs after it was renamed in
  958fd0b
- fail RTD build if docs build generates warnings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs should use RTD theme for local dev builds
1 participant