John's CloudFormation templates and devops scripts
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
docs_src
utils
.gitignore
LICENSE
README.md
manage.py

README.md

John's Cloud

John's CloudFormation templates, devops scripts and Docker templates.

Documentation in http://john-cd.com/johnscloud/

Documentation Generation

Documentation output files in /docs are generated by Mkdocs from source files in /docs_src.

To install MkDocs / create a new documentation site:

$ pip install mkdocs
$ mkdocs new docs_src

To build the documentation site:

$ cd docs_src
$ mkdocs build

To start the live-reloading docs server - http://localhost:8000/

$ mkdocs serve

Then configure GitHub Pages to use the master branch, /docs folder.

Optionally, MkDocs can use the ghp-import tool to commit to the gh-pages branch and push the gh-pages branch to GitHub Pages:

$ mkdocs gh-deploy

For full documentation visit mkdocs.org.

Project layout

/src/
    infrastructure/
    docker/
/utils/
/docs/
/docs_src/
    mkdocs.yml    # The configuration file.
    src/
        index.md  # The documentation homepage.
        ...       # Other markdown pages, images and other files.