[CDRIVER-3597] Replace the taglist extension with includes Created: 31/Mar/20  Updated: 28/Oct/23  Resolved: 14/Oct/20

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.18.0, 1.17.2, 1.18.0-alpha

Type: Improvement Priority: Minor - P4
Reporter: Kevin Albertson Assignee: Roberto Sanchez
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 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.



 Comments   
Comment by Githook User [ 22/Oct/20 ]

Author:

{'name': 'Roberto C. Sánchez', 'email': 'roberto@connexer.com', 'username': 'rcsanchez97'}

Message: CDRIVER-3597 replace taglist extension with includes, 2
Branch: r1.17
https://github.com/mongodb/mongo-c-driver/commit/2076feca355bd7fd5718fa83cec13e713d5c4d07

Comment by Githook User [ 22/Oct/20 ]

Author:

{'name': 'Roberto C. Sánchez', 'email': 'roberto@connexer.com', 'username': 'rcsanchez97'}

Message: CDRIVER-3597 replace taglist extension with includes, 2
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/34decbfead6122ccba2aa47e8924fbe7d42eb700

Comment by Githook User [ 14/Oct/20 ]

Author:

{'name': 'Roberto C. Sánchez', 'email': 'roberto@connexer.com', 'username': 'rcsanchez97'}

Message: CDRIVER-3597 replace taglist extension with includes
Branch: r1.17
https://github.com/mongodb/mongo-c-driver/commit/af91de7f1f6e4cdbaf5f0dd6ea4312fabb7257be

Comment by Kevin Albertson [ 14/Oct/20 ]

Great, let's cherry pick onto 1.17 for now and add this to the 1.17.2 fixVersion. We'll do a 1.17.2 release (should be the first Tuesday of November, per our patch release policy).

Comment by Roberto Sanchez [ 14/Oct/20 ]

kevin.albertson I just confirmed that the fix for this ticket fixes the build failure reported in Debian bug 971201. If you would like to cherry pick commit d0d511f40 onto the r1.17 branch and then release 1.17.2, then I can build and upload the corresponding Debian package.

Comment by Githook User [ 14/Oct/20 ]

Author:

{'name': 'Roberto C. Sánchez', 'email': 'roberto@connexer.com', 'username': 'rcsanchez97'}

Message: CDRIVER-3597 replace taglist extension with includes
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/d0d511f40038b87d2784058d8c8596f0164c6655

Comment by Roberto Sanchez [ 27/Sep/20 ]

c.f. https://bugs.debian.org/971201

Generated at Wed Feb 07 21:18:30 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.