SourceDocs is a command line tool that generates markdown documentation files from inline source code comments.
Similar to Sphinx or Jazzy, SourceDocs parses your Swift source code and generates beautiful reference documentation. In contrast to those other tools, SourceDocs generates markdown files that you can store and browse inline within your project repository or render with GitHub Pages.
- ✅ Browse reference documentation within the project repository (great for private projects)
- ✅ Browse reference documentation on GitHub Pages (great for public projects)
Requirements:
- Swift 4 runtime installed in your computer.
$ brew install jhildensperger/tap/sourcedocs
$ git clone https://github.com/jhildensperger/SourceDocs.git
$ cd SourceDocs
$ make
To generate documentation from your source code, run the sourcedocs command directly
from the root your project or use the --source option with the path to your source.
$ cd ~/path/to/MyAppOrFramework
$ sourcedocs generate
or
$ sourcedocs generate --source ~/path/to/MyAppOrFramework
This command will analyze your MyAppOrFramework project and generate reference
documentation from all public types found. The documentation is written to
the directory Documentation/Reference relative to the root of your project repository.
You can also use the --output option to specific an output directory.
Typing sourcedocs help we get a list of all available commands:
$ sourcedocs help
Available commands:
clean Delete the output folder and quit.
generate Generates the Markdown documentation
help Display general or command-specific help
version Display the current version of SourceDocs
Typing sourcedocs help <command> we get a list of all options for that command:
$ sourcedocs help generate
Generates the Markdown documentation
[--spm-module (string)]
Generate documentation for Swift Package Manager module.
[--module-name (string)]
Generate documentation for a Swift module.
[--output (string)]
Output directory (defaults to Documentation/Reference).
[--source (string)]
Source directory (defaults to current directory).
[--contents-filename (string)]
Filename used for the root markdown file (defaults to README).
--module-name-path|-m
Include the module name as part of the output folder path.
--extension-in-links|-e
Include the .md file extension in links.
--clean|-c
Delete output folder before generating documentation.
--collapsible|-l
Put methods, properties and enum cases inside collapsible blocks.
--table-of-contents|-t
Generate a table of contents with properties and methods for each type.
[[]]
List of arguments to pass to xcodebuild.
Usually, for most Xcode projects, no parameters are needed at all. xcodebuild
should be able to find the default project and scheme.
If the command fails, try specifying the scheme (-scheme SchemeName) or the
workspace. Any arguments passed to sourcedocs after -- will be passed to
xcodebuild without modification.
$ sourcedocs generate -- -scheme MyScheme
For Swift Package Manager modules, you can the module name using the
--spm-module parameter.
$ sourcedocs generate --spm-module SourceDocsDemo
SourceDocs writes documentation files to the Documentation/Reference directory relative
to your project root. This allows for the generated documentation to live along
other hand-crafted documentation you might have written or will write in the future.
When specifying a module name, the documentation files will be written to
Documentation/Reference/<module name>.
We highly recommend adding the generated documentation to your source code repository, so it can be easily browsed inline. GitHub and BitBucket do a great job rendering Markdown files, so your documentation will be very nice to read.
If you find an issue, just open a ticket on it. Pull requests are warmly welcome as well.
SourceDocs is licensed under the MIT license. See LICENSE for more info.