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.
You can find more information here
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
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.
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.