Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-2103

Use sphinx features for findAndModify docs

    XMLWordPrintableJSON

Details

    • Icon: Improvement Improvement
    • Resolution: Done
    • Icon: Minor - P4 Minor - P4
    • 1.9.0
    • None
    • docs, libmongoc

    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.

      Attachments

        Activity

          People

            kevin.albertson@mongodb.com Kevin Albertson
            jesse@mongodb.com A. Jesse Jiryu Davis
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: