Skip to content

Commit

Permalink
sagemathgh-38608: Add warning filter for DeprecationWarning while doc…
Browse files Browse the repository at this point in the history
… 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
  • Loading branch information
Release Manager committed Sep 8, 2024
2 parents a0db75e + daaf04b commit 13f21d7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/sage_docbuild/sphinxbuild.py
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,11 @@ def runsphinx():
saved_stdout = sys.stdout
saved_stderr = sys.stderr

if not sys.warnoptions:
import warnings
original_filters = warnings.filters[:]
warnings.filterwarnings("ignore", category=DeprecationWarning, module='sphinx.util.inspect')

try:
sys.stdout = SageSphinxLogger(sys.stdout, os.path.basename(output_dir))
sys.stderr = SageSphinxLogger(sys.stderr, os.path.basename(output_dir))
Expand All @@ -323,3 +328,6 @@ def runsphinx():
sys.stderr = saved_stderr
sys.stdout.flush()
sys.stderr.flush()

if not sys.warnoptions:
warnings.filters = original_filters[:]

0 comments on commit 13f21d7

Please sign in to comment.