[CDRIVER-2103] Use sphinx features for findAndModify docs Created: 29/Mar/17  Updated: 07/May/18  Resolved: 06/Sep/17

Status: Closed
Project: C Driver
Component/s: docs, libmongoc
Affects Version/s: None
Fix Version/s: 1.9.0

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


 Description   

We use an inconvenient hack in fam.c to split parts of the example into separate C files and #include them together. This was required for Mallard documentation, but with Sphinx we can use the "literalinclude" directive's options "start-after" and "end-before" with unique comments in the source file. That will let us combine all the examples into one file and simplify our build system.



 Comments   
Comment by Githook User [ 07/Sep/17 ]

Author:

{'username': 'bjori', 'name': 'Hannes Magnusson', 'email': 'bjori@php.net'}

Message: CDRIVER-2103 Fix executable name
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/a7e2ad129c15257aa05417c8cc1a00049617b4ba

Comment by Githook User [ 06/Sep/17 ]

Author:

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

Message: Merge pull request #437 from kevinAlbs/cdriver2103

CDRIVER-2103 Merge find-and-modify examples
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/294976a086ce1a1d7c8dc904d8ba2503ae7e648e

Comment by Githook User [ 06/Sep/17 ]

Author:

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

Message: CDRIVER-2103 Merge find-and-modify examples
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/d773e3a5f8141866f31fbdf80844fdb42a5cf7fd

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