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

Make better use of Sphinx and rST documenation tools

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Won't Do
    • Icon: Unknown Unknown
    • None
    • None
    • None

    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.

      Attachments

        Activity

          People

            Unassigned Unassigned
            colby.pike@mongodb.com Colby Pike
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: