[CDRIVER-2377] Verify sphinx version in conf.py Created: 16/Nov/17  Updated: 28/Oct/23  Resolved: 29/Jan/18

Status: Closed
Project: C Driver
Component/s: Build, docs
Affects Version/s: None
Fix Version/s: 1.10.0

Type: Improvement Priority: Minor - P4
Reporter: A. Jesse Jiryu Davis Assignee: A. Jesse Jiryu Davis
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

I frequently have mysterious problems building the docs, only to discover it's because I'm using an ancient version of Sphinx from a Linux package manager instead of the latest version from "pip". Choose a recent version to require and check it in conf.py for libbson and libmongoc.



 Comments   
Comment by Githook User [ 29/Jan/18 ]

Author:

{'email': 'jesse@mongodb.com', 'name': 'A. Jesse Jiryu Davis', 'username': 'ajdavis'}

Message: CDRIVER-2377 require sphinx 1.6+
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/4a74cdfc941c0e30ef1d605a21bc089a7d6ccfa8

Comment by Bernie Hackett [ 07/Dec/17 ]

Neat! I had no idea that existed.

Comment by A. Jesse Jiryu Davis [ 07/Dec/17 ]

See http://www.sphinx-doc.org/en/1.5.1/config.html#confval-needs_sphinx

Comment by Bernie Hackett [ 16/Nov/17 ]

This may implicitly require a minimum python version. If you're planning to use a special error message you might want to be explicit about the python version as well.

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