Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-8452

Support styling for external links (e.g. to reference docs without a sphinx inventory)

    XMLWordPrintableJSON

Details

    • Icon: Improvement Improvement
    • Resolution: Won't Fix
    • Icon: Major - P3 Major - P3
    • Server_Docs_20231030
    • None
    • tools
    • None

    Description

      It would be helpful to be able to make a link to an external page (e.g. to the mongodb php extension reference) be fixed width. This is absolutely not something that sphinx/docutils supports and it doesn't seem like that's likely to come about in the near future.

      The workaround is to use a combination of substitutions, references, and the replace directive, which is obviously not something we're going to do.

      extlinks in conf.py, which makes it easier to link out to stuff, does not allow you to style the links though it does support adding a prefix to it that must be a string. Perhaps that's an avenue to investigate. Intersphinx doesn't work for non-sphinx projects, though that would be a lovely alternative.

      As the driver docs move more and more to ReST, this is – I think – something we'll need to sort out.

      Attachments

        Activity

          People

            jonathan.destefano@mongodb.com Jonathan DeStefano
            allison.moore@mongodb.com Allison Reinheimer Moore
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              3 years, 34 weeks ago