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

Add warning filter for DeprecationWarning while doc build #38608

Merged
merged 1 commit into from
Sep 15, 2024

Conversation

kwankyu
Copy link
Collaborator

@kwankyu kwankyu commented Sep 4, 2024

Fixes #37664.

from the log of the doc build workflow of this PR,

  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links reference/cryptography inventory 
  [sagemath_doc_html-none] [spkg-install] [cryptogra] Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
  [sagemath_doc_html-none] [spkg-install] [cryptogra] building [inventory]: targets for 25 source files that are out of date
  [sagemath_doc_html-none] [spkg-install] [cryptogra] updating environment: [new config] 25 added, 0 changed, 0 removed
  [sagemath_doc_html-none] [spkg-install] [cryptogra] The inventory file is in ../../local/share/doc/sage/inventory/en/reference/cryptography.
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links reference/curves inventory 

This PR is based on #38580 and replaces it. Thank @thecaligarmo for allowing this arrangement.

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

⌛ Dependencies

@kwankyu kwankyu changed the title Add deprecation warning filter Add warning filter for DeprecationWarning while doc build Sep 4, 2024
@kwankyu kwankyu marked this pull request as ready for review September 4, 2024 06:12
Copy link

github-actions bot commented Sep 4, 2024

Documentation preview for this PR (built with commit daaf04b; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

@kwankyu kwankyu requested a review from mkoeppe September 4, 2024 13:57
Copy link
Contributor

@mkoeppe mkoeppe left a comment

Choose a reason for hiding this comment

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

LGTM.

@mkoeppe
Copy link
Contributor

mkoeppe commented Sep 4, 2024

Thanks @thecaligarmo and @kwankyu.

vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 5, 2024
… build

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fixes sagemath#37664.

from the log of the doc build workflow of this PR,
```
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/cryptography inventory
  [sagemath_doc_html-none] [spkg-install] [cryptogra] Converting
`source_suffix = '.rst'` to `source_suffix = {'.rst':
'restructuredtext'}`.
  [sagemath_doc_html-none] [spkg-install] [cryptogra] building
[inventory]: targets for 25 source files that are out of date
  [sagemath_doc_html-none] [spkg-install] [cryptogra] updating
environment: [new config] 25 added, 0 changed, 0 removed
  [sagemath_doc_html-none] [spkg-install] [cryptogra] The inventory file
is in ../../local/share/doc/sage/inventory/en/reference/cryptography.
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/curves inventory
```

This PR is based on sagemath#38580 and replaces it. Thank @thecaligarmo for
allowing this arrangement.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38608
Reported by: Kwankyu Lee
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 6, 2024
… build

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fixes sagemath#37664.

from the log of the doc build workflow of this PR,
```
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/cryptography inventory
  [sagemath_doc_html-none] [spkg-install] [cryptogra] Converting
`source_suffix = '.rst'` to `source_suffix = {'.rst':
'restructuredtext'}`.
  [sagemath_doc_html-none] [spkg-install] [cryptogra] building
[inventory]: targets for 25 source files that are out of date
  [sagemath_doc_html-none] [spkg-install] [cryptogra] updating
environment: [new config] 25 added, 0 changed, 0 removed
  [sagemath_doc_html-none] [spkg-install] [cryptogra] The inventory file
is in ../../local/share/doc/sage/inventory/en/reference/cryptography.
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/curves inventory
```

This PR is based on sagemath#38580 and replaces it. Thank @thecaligarmo for
allowing this arrangement.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38608
Reported by: Kwankyu Lee
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 8, 2024
… build

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fixes sagemath#37664.

from the log of the doc build workflow of this PR,
```
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/cryptography inventory
  [sagemath_doc_html-none] [spkg-install] [cryptogra] Converting
`source_suffix = '.rst'` to `source_suffix = {'.rst':
'restructuredtext'}`.
  [sagemath_doc_html-none] [spkg-install] [cryptogra] building
[inventory]: targets for 25 source files that are out of date
  [sagemath_doc_html-none] [spkg-install] [cryptogra] updating
environment: [new config] 25 added, 0 changed, 0 removed
  [sagemath_doc_html-none] [spkg-install] [cryptogra] The inventory file
is in ../../local/share/doc/sage/inventory/en/reference/cryptography.
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/curves inventory
```

This PR is based on sagemath#38580 and replaces it. Thank @thecaligarmo for
allowing this arrangement.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38608
Reported by: Kwankyu Lee
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 8, 2024
… build

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fixes sagemath#37664.

from the log of the doc build workflow of this PR,
```
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/cryptography inventory
  [sagemath_doc_html-none] [spkg-install] [cryptogra] Converting
`source_suffix = '.rst'` to `source_suffix = {'.rst':
'restructuredtext'}`.
  [sagemath_doc_html-none] [spkg-install] [cryptogra] building
[inventory]: targets for 25 source files that are out of date
  [sagemath_doc_html-none] [spkg-install] [cryptogra] updating
environment: [new config] 25 added, 0 changed, 0 removed
  [sagemath_doc_html-none] [spkg-install] [cryptogra] The inventory file
is in ../../local/share/doc/sage/inventory/en/reference/cryptography.
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/curves inventory
```

This PR is based on sagemath#38580 and replaces it. Thank @thecaligarmo for
allowing this arrangement.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38608
Reported by: Kwankyu Lee
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 10, 2024
… build

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fixes sagemath#37664.

from the log of the doc build workflow of this PR,
```
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/cryptography inventory
  [sagemath_doc_html-none] [spkg-install] [cryptogra] Converting
`source_suffix = '.rst'` to `source_suffix = {'.rst':
'restructuredtext'}`.
  [sagemath_doc_html-none] [spkg-install] [cryptogra] building
[inventory]: targets for 25 source files that are out of date
  [sagemath_doc_html-none] [spkg-install] [cryptogra] updating
environment: [new config] 25 added, 0 changed, 0 removed
  [sagemath_doc_html-none] [spkg-install] [cryptogra] The inventory file
is in ../../local/share/doc/sage/inventory/en/reference/cryptography.
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/curves inventory
```

This PR is based on sagemath#38580 and replaces it. Thank @thecaligarmo for
allowing this arrangement.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38608
Reported by: Kwankyu Lee
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Sep 12, 2024
… build

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fixes sagemath#37664.

from the log of the doc build workflow of this PR,
```
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/cryptography inventory
  [sagemath_doc_html-none] [spkg-install] [cryptogra] Converting
`source_suffix = '.rst'` to `source_suffix = {'.rst':
'restructuredtext'}`.
  [sagemath_doc_html-none] [spkg-install] [cryptogra] building
[inventory]: targets for 25 source files that are out of date
  [sagemath_doc_html-none] [spkg-install] [cryptogra] updating
environment: [new config] 25 added, 0 changed, 0 removed
  [sagemath_doc_html-none] [spkg-install] [cryptogra] The inventory file
is in ../../local/share/doc/sage/inventory/en/reference/cryptography.
  [sagemath_doc_html-none] [spkg-install] sage --docbuild --no-pdf-links
reference/curves inventory
```

This PR is based on sagemath#38580 and replaces it. Thank @thecaligarmo for
allowing this arrangement.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38608
Reported by: Kwankyu Lee
Reviewer(s): Matthias Köppe
@vbraun vbraun merged commit abcf4a6 into sagemath:develop Sep 15, 2024
16 of 21 checks passed
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.

Muffle DeprecationWarning during docbuild
3 participants