[CDRIVER-4267] Make better use of Sphinx and rST documenation tools Created: 25/Jan/22 Updated: 28/Mar/23 Resolved: 28/Mar/23 |
|
| Status: | Closed |
| Project: | C Driver |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Unknown |
| Reporter: | Colby Pike | Assignee: | Unassigned |
| Resolution: | Won't Do | Votes: | 0 |
| Labels: | rb-track | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||
| Quarter: | FY24Q2 | ||||
| Description |
|
Currently, the C API documentation is hand-written separate from the corresponding code in rST documents, nor using the appropriate markup for the C domain. Combining Sphinx with the Doxygen documentation extractor via Breathe and using the appropriate markup in rST will result in more uniform and easy-to-maintain documentation pages. |