Skip to content

Commit

Permalink
move documentation from readme to gh pages
Browse files Browse the repository at this point in the history
  • Loading branch information
simskij committed Jun 1, 2019
1 parent 985a922 commit 34b7659
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 451 deletions.
28 changes: 28 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
version: 2.1

executors:
py:
docker:
- image: circleci/python:latest
working_directory: ~/repo
go:
docker:
- image: circleci/golang:latest
Expand Down Expand Up @@ -50,6 +54,15 @@ workflows:
ignore: /.*/
tags:
only: /^v[0-9]+(\.[0-9]+)*$/
- publish-docs:
requires:
- testing
- linting
filters:
branches:
ignore: /.*/
tags:
only: /^v[0-9]+(\.[0-9]+)*$/
jobs:
checkout:
executor: go
Expand Down Expand Up @@ -203,3 +216,18 @@ jobs:
-e DOCKER_REPOSITORY=containrrr/watchtower \
-e GIT_BRANCH=master \
lsiodev/readme-sync bash -c 'node sync'
publish-docs:
executor: py
steps:
- attach_workspace:
at: .
- run:
name: Install prerequisites
command: |
pip install \
mkdocs \
mkdocs-material \
md-toc
- run:
name: Generate and publish
command: mkdocs gh-deploy
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ vendor
.glide
dist
.idea
.DS_Store
.DS_Store
/docs
/site
Loading

0 comments on commit 34b7659

Please sign in to comment.