Skip to content

Docs: update versions on config file page #9838

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

Merged
merged 4 commits into from
Dec 22, 2022
Merged

Conversation

humitos
Copy link
Member

@humitos humitos commented Dec 22, 2022

  • Update all the versions used in the examples to the latest ones supported by Read the Docs.
  • Remove deprecated keys from examples, like python.version: "3.7"

This way we avoid new users copy and pasting examples with outdated versions.


📚 Documentation previews 📚

- Update all the versions used in the examples to the latest ones supported by
  Read the Docs.
- Remove deprecated keys from examples, like `python.version: "3.7"`

This way we avoid new users copy and pasting examples with outdated versions.
@humitos humitos requested a review from a team as a code owner December 22, 2022 12:07
@humitos humitos requested a review from agjohnson December 22, 2022 12:07
@benjaoming
Copy link
Contributor

Other files found:

docs/user/faq.rst
260:      - python=3.9

docs/user/tutorial/index.rst
325:       python: "3.8"
341:You will notice that one of the lines contains ``python3.8``:
345:.. figure:: /_static/images/tutorial/build-python3.8.png
388:       python: "3.8"

docs/user/environment-variables.rst
106:       python: 3.10

docs/user/guides/conda.rst
51:      - python=3.8
59:   whereas ``python=3.8`` (single ``=``) will fetch the latest ``3.8.*`` version,
98:      - python=3.8
157:      - python=3.8
194:      - python=3.8

@benjaoming
Copy link
Contributor

This way we avoid new users copy and pasting examples with outdated versions.

👍

(also we avoid users thinking that we somehow don't support newer versions of Python!)

Copy link
Contributor

@benjaoming benjaoming left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noted some other files with Python versions in examples. I don't want to scope creep this, as the current update is already a much-needed improvement.

We could need replacement variables like |example_python_version|, |example_sphinx_version| etc... although they might a) not work in code blocks and b) might not work in any context.

Co-authored-by: Benjamin Balder Bach <[email protected]>
@humitos
Copy link
Member Author

humitos commented Dec 22, 2022

Failing test is trim API 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants