RTD docs build fails on stale search/vector-search intersphinx doc paths

ExportXMLWordPrintableJSON

    • Type: Task
    • Resolution: Done
    • Priority: Major - P3
    • None
    • Affects Version/s: None
    • Component/s: django
    • None
    • Python Drivers
    • Not Needed
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      Name of Failure:

      Read the Docs build fails with fail_on_warning errors from unknown intersphinx document references.

      Link to task:

      https://app.readthedocs.org/projects/django-mongodb-backend/builds/34304291/

      Context of when and why the failure occurred:

      Three :doc: references in docs/ref/models/indexes.rst point at paths under index/ in the search and vector-search intersphinx inventories. Those inventories now list the pages under indexes/ (plural), so Sphinx can't resolve the targets and, with fail_on_warning: true, the warnings fail the build.

      Stack trace:

      docs/ref/models/indexes.rst:56: WARNING: unknown document: 'search:index/index-definitions' [ref.doc]
docs/ref/models/indexes.rst:74: WARNING: unknown document: 'search:index/analyzers/overview' [ref.doc]
docs/ref/models/indexes.rst:91: WARNING: unknown document: 'vector-search:index/vector-search-type' [ref.doc]
build finished with problems, 3 warnings (with warnings treated as errors).

            Assignee:
            Steve Silvester
            Reporter:
            Steve Silvester
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: