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

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 python # if you don't have pip already
[sudo] pip install -r requirements.txt

Note: If you use sudo to run pip, you might need to use the -H flag of sudo.

Troubleshooting

Due to a bug in pip trying to uninstall El Capitan's version of six (protected by SIP) when needing a new one, you may encounter the following error during pip install -r requirements.txt:

OSError: [Errno 1] Operation not permitted: '/tmp/pip-[…]-uninstall/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/six-1.4.1-py2.7.egg-info'

In this case, just install six using the --ignore-installed flag first before retrying:

[sudo] pip install --ignore-installed six
[sudo] pip install -r requirements.txt

Adding a Python dependency

Likely, to add a Markdown extension.

Install with pip install <some extension>
Add to requirements-to-freeze.txt.
Run pip freeze > requirements.txt to update the exact requirements.

Why requirements-to-freeze.txt?

Based on A Better Pip Workflow, requirements-to-freeze.txt and requirements.txt provide a similar experience to Gemfile and Gemfile.lock, respectively.

requirements-to-freeze.txt lets you pick out the top level packages the project depends on, while requirements.txt exactly specifies all of the dependencies and subdependencies for repeatable builds.

docs's People