Docs build uses deprecated Sphinx APIs, will likely fail in Sphinx 9.x

XMLWordPrintableJSON

    • Type: Bug
    • Resolution: Unresolved
    • Priority: Unknown
    • None
    • Affects Version/s: None
    • Component/s: None
    • None
    • None
    • C Drivers
    • None
    • None
    • None
    • None
    • None
    • None

      Summary

      The mongoc_common.py:generate_html_redirs function uses Sphinx APIs that are deprected in 8.0 and are slated for removal in 9.0. When 9.0 releases, it can be expected that downstream packagers using up-to-date Sphinx will begin to see issues with the dirhtml builder.

      Potential fixes:

      1. Branch in generate_html_redirs to detect Sphinx 9.0 and do something different
      2. Find a new way to generate the HTML redirect files
      3. Stop generating the HTML redirects if building with newer Sphinx (we only need the redirects to support externally hosted links that point to the public docs pages in their -b html locations, and we control our Sphinx version, so other users don't need these redirects).

      Environment

      Currently, with Sphinx 7.x, there is no issue. When building dirhtml with Sphinx 8.x, a deprecation warning is issued during the build, warning that the annotated APIs will be removed in 9.x.

      How to Reproduce

      Install Sphinx 8.x and run a documentation build with -b dirhtml. Deprecation warnings will be printed in the output.

            Assignee:
            Unassigned
            Reporter:
            Colby Pike
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: