- Edit this documentation
- External documentations
- When are the docs deployed ?
- Testing the statically built site
Learn how to use Cozy, host your own server and develop applications.
This documentation is built with MkDocs.
All sources are in the dev branch and the master branch contains the "live" built site. The CI builds the site from the dev branch and automatically publish the built result in the master branch.
/!\ PLEASE DO NOT DIRECTLY EDIT THE master BRANCH
To edit the documentation, just edit the files inside src on the dev branch.
If you want to see your updates, install mkdocs:
In most linux distribution, it will install binary in ~/local/bin/, add it to your path.
Fetch external documentation and add it to mkdocs.yml (do not commit changes done in mkdocs.yml) :
# Activate a virtualenv if you want (recommended)
pip install -r requirements.txt
./build.shExpected python version is 3
Run MkDocs:
mkdocs serveAnd point your favorite browser to http://127.0.0.1:8000/
External documentations are listed in the OUTSIDE_DOCS file. They are consolidated in this documentation during build. This lets developers edit their documentation in their repository while the single site makes it convenient to search for information only in one location.
Each repository maintains its own table of contents, which controls what is shown under the References menu.
See ./build.sh, and ./generate_config.py scripts for more information.
The edit links displayed in the header of each article are modified via Javascript to handle outside repositories (mkdocs does not support this natively).
The documentation build is triggerd automatically and built by Travis
- when a commit is pushed on the
devbranch - every day (since we cannot detect changes in external documentations)
After the build, it is available on https://docs.cozy.io/.
You can trigger a manual build on https://travis-ci.com/cozy/cozy.github.io > More options > Trigger build.
To test the whole site:
./build.sh
cd site/
python -m SimpleHTTPServer