swift-rst-docs 2.1

Generate RST Swift documentation for Sphinx.

swift-rst-docs

Python library, cli and Sphinx extension to generate documentation for Swift projects from SourceKitten output files.

Installation

$ pip install swift-rst-docs
$ brew install sourcekitten

Usage

You need to generate a JSON file with SourceKitten first. To reference symbols in your documentation, place their full name between 4 backticks. For example: ``MyStructure.hello(world:)`` or ``MySwiftLibrary.MyStructure.hello(world:)`` when referencing from another module or the documentation's overview text. This will create a link to the symbol's page.

$ sourcekitten doc [--spm] [-- <swift / xcodebuild arguments>] > documentation.json

See the documentation for the various ways of generating documentation pages and an example of a generated Swift documentation. The example documentation is in the repo's docs/swift directory and the SourceKitten documentation files are generated from the tests/MySwiftPackage/generate-documentation.sh