I had a long train journey today so finished off an initial cut of a conversion of the existing IIO DocBook over to Sphinx. There are various issues with the kernel doc in some of our source files that need cleaning up, but thought I'd get this out for people to be able to take a first look. For now I've basically left any editorial work out. This is just format conversion (with simple stuff like cross references added as I went along). I did it by hand because I wanted to get to know the new syntax - that may well have meant I made different decisions on some of the formatting! One thing I would love, would be cross referencing to structure members. A lot of IIO stuff is done by assigning these members of some really quite large structures. Note whilst Daniel did a great job on these initial docs, they are far from complete - so I'd envision adding at least sections on: 1) A structural overview - probably diagrams of how the whole thing fits together. 2) in kernel interface description 3) Illustrations of 'exceptions' to the standard way of doing things (e.g. buffers without triggers) 4) DMA buffers etc. 5) Events Jonathan Jonathan Cameron (1): docs: IIO documentation Documentation/driver-api/iio/buffers.rst | 127 +++++++++++++++ Documentation/driver-api/iio/core.rst | 180 +++++++++++++++++++++ Documentation/driver-api/iio/index.rst | 15 ++ Documentation/driver-api/iio/intro.rst | 23 +++ Documentation/driver-api/iio/triggered-buffers.rst | 70 ++++++++ Documentation/driver-api/iio/triggers.rst | 78 +++++++++ Documentation/driver-api/index.rst | 1 + 7 files changed, 494 insertions(+) create mode 100644 Documentation/driver-api/iio/buffers.rst create mode 100644 Documentation/driver-api/iio/core.rst create mode 100644 Documentation/driver-api/iio/index.rst create mode 100644 Documentation/driver-api/iio/intro.rst create mode 100644 Documentation/driver-api/iio/triggered-buffers.rst create mode 100644 Documentation/driver-api/iio/triggers.rst -- 2.10.2 -- To unsubscribe from this list: send the line "unsubscribe linux-iio" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
