[CDRIVER-4788] Provide alternate for python-sphinx-design Created: 24/Nov/23  Updated: 05/Dec/23  Resolved: 05/Dec/23

Status: Closed
Project: C Driver
Component/s: Build
Affects Version/s: None
Fix Version/s: 1.25.2

Type: Task Priority: Major - P3
Reporter: Rishabh Bisht Assignee: Kevin Albertson
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
is depended on by PHPC-2333 Investigate changes in CDRIVER-4788: ... Closed
Related
related to CDRIVER-4767 Please provide a usable archive Investigating

 Description   

Context (From CDRIVER-4767)

Impact

  • Since python-sphinx-design is not available, the C driver package can't be built for EPEL.
  • We also can't ship without documentation as it would be considered a breaking change.
  • Thus, users on Red Hat systems can't get access to pre built binaries of latest C Driver.

Expected

  • Provide any alternate that can be used instead of python-sphinx-design (perhaps rollback to previous one?) for EPEL package, until python-sphinx-design is built for EPEL.
  • This is a temporary workaround and resultant docs having a different look and feel is acceptable. 


 Comments   
Comment by Githook User [ 05/Dec/23 ]

Author:

{'name': 'Kevin Albertson', 'email': 'kevin.albertson@mongodb.com', 'username': 'kevinAlbs'}

Message: CDRIVER-4788 do not require sphinx-design for man pages (#1483)

  • do not require sphinx-design

sphinx-design is not used in the man pages. Do not require sphinx-design to enable building man pages when sphinx-design is not available.

  • error if building HTML docs without sphinx-design
  • remove `python3-sphinx` from mock install

`python3-sphinx` is listed in BuildRequires of spec file and does not need to be installed separately.

  • update spec.patch to remove `python3-sphinx-design`

Intended to test the RPM build without the `python3-sphinx-design` dependency installed.

  • commit staged files

This is intended to test files changed in a patch build.
Patch builds apply changes to index.
Branch: r1.25
https://github.com/mongodb/mongo-c-driver/commit/80bf0d30a5f46de68321ac5580280b56dc8fe3a9

Comment by Githook User [ 05/Dec/23 ]

Author:

{'name': 'Kevin Albertson', 'email': 'kevin.albertson@mongodb.com', 'username': 'kevinAlbs'}

Message: CDRIVER-4788 do not require sphinx-design for man pages (#1483)

  • do not require sphinx-design

sphinx-design is not used in the man pages. Do not require sphinx-design to enable building man pages when sphinx-design is not available.

  • error if building HTML docs without sphinx-design
  • remove `python3-sphinx` from mock install

`python3-sphinx` is listed in BuildRequires of spec file and does not need to be installed separately.

  • update spec.patch to remove `python3-sphinx-design`

Intended to test the RPM build without the `python3-sphinx-design` dependency installed.

  • commit staged files

This is intended to test files changed in a patch build.
Patch builds apply changes to index.
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/3c51f9d1f1a5e44d4fdc09b934c11300d9768044

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