Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-3597

Replace the taglist extension with includes

    XMLWordPrintable

Details

    • Improvement
    • Status: Closed
    • Minor - P4
    • Resolution: Fixed
    • None
    • 1.18.0, 1.17.2, 1.18.0-alpha
    • docs
    • None

    Description

      Our docs currently use he taglist extension, which is an archived / unmaintained project (https://github.com/spinus/sphinxcontrib-taglist), and was the cause of the warning of CDRIVER-3594:

      AFAICT, the taglist extension is only used to generate some of the "See Also"
      links on pages, like this one:
      http://mongoc.org/libmongoc/current/mongoc_uri_get_auth_mechanism.html#taglist
      generated from:
      https://github.com/mongodb/mongo-c-driver/blob/1.16.0/src/libmongoc/doc/mongo...

      If that's all it's used for, let's remove it. From some quick searching I
      did not see a quick replacement for taglists. But we could do something simpler.
      Replace the lists of links with an include file:

      ```
      .. taglist:: See Also:
      :tags: authmechanism
      ```

      Becomes:

      ```
      .. include:: includes/seealso/authmechanism.txt
      ```

      And that file can just have a plain old list.

      Attachments

        Activity

          People

            roberto.sanchez@mongodb.com Roberto Sanchez
            kevin.albertson@mongodb.com Kevin Albertson
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: