omensight / docs

All the fastlane docs

fastlane docs

This repo contains all documentation for fastlane. You can find the .md files inside the docs folder.

To preview the updated documentation locally, just clone the repo, modify the file, and run. Note that some of the files are in generated folder and are later copied with mkdocs pre-build hook.

mkdocs serve

The live version is available on docs.fastlane.tools.

Why new docs?

You can find more information here

Deploy changes

Once a PR is merged into master, the latest version will automatically be deployed to docs.fastlane.tools by one of the hard-working fastlane bots. No need to do anything manually. The resulting HTML files are stored in the gh-pages branch.

Installation of mkdocs

brew install python3 # if you don't have pip already
brew install pipenv
pipenv --three
# install dependencies from Pipfile.lock and run shell
pipenv install
pipenv shell

Adding a Python dependency

Likely, to add a Markdown extension, install it with pipenv install <some extension> after making sure the virtualenv is loaded (pipenv shell).

Troubleshooting local docs server

Running a local server with mkdocs serve takes several minutes. It looks like mkdocs needs some time to read available-plugins.md. It can be confirmed by running mkdocs serve --verbose as mkdocs is stuck at reading this file.

To test changes on pages other than the list of available plugins, it is convenient to edit docs/generated/available-plugins.md, removing all of its content and saving the file before running mkdocs serve.