From d036bf3a2a7129e4c12904facba4a55f875a45d1 Mon Sep 17 00:00:00 2001 From: Harshavardhana Date: Sun, 8 Feb 2015 17:40:39 -0800 Subject: [PATCH] Restructure docs and move mkdocs.yml to top-level --- .gitignore | 1 + Makefile | 3 +++ docs/.gitignore | 1 - docs/{docs => }/api/manage.md | 0 docs/{docs => }/api/minio.md | 0 docs/{docs => }/architecture.md | 0 docs/{docs => }/index.md | 0 docs/mkdocs.yml => mkdocs.yml | 0 docs/docs_linux.go => mkdocs_linux.go | 2 +- 9 files changed, 5 insertions(+), 2 deletions(-) delete mode 100644 docs/.gitignore rename docs/{docs => }/api/manage.md (100%) rename docs/{docs => }/api/minio.md (100%) rename docs/{docs => }/architecture.md (100%) rename docs/{docs => }/index.md (100%) rename docs/mkdocs.yml => mkdocs.yml (100%) rename docs/docs_linux.go => mkdocs_linux.go (73%) diff --git a/.gitignore b/.gitignore index 7897aa813..48dcf2b02 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ **/*.swp +site/ cover.out *~ minio diff --git a/Makefile b/Makefile index 6c51d6b10..a1b53638f 100644 --- a/Makefile +++ b/Makefile @@ -37,6 +37,9 @@ restore: env: @godep go env +docs-deploy: + @mkdocs gh-deploy --clean + clean: @echo "Cleaning up all the generated files" @rm -fv pkg/utils/split/TESTPREFIX.* diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 45ddf0ae3..000000000 --- a/docs/.gitignore +++ /dev/null @@ -1 +0,0 @@ -site/ diff --git a/docs/docs/api/manage.md b/docs/api/manage.md similarity index 100% rename from docs/docs/api/manage.md rename to docs/api/manage.md diff --git a/docs/docs/api/minio.md b/docs/api/minio.md similarity index 100% rename from docs/docs/api/minio.md rename to docs/api/minio.md diff --git a/docs/docs/architecture.md b/docs/architecture.md similarity index 100% rename from docs/docs/architecture.md rename to docs/architecture.md diff --git a/docs/docs/index.md b/docs/index.md similarity index 100% rename from docs/docs/index.md rename to docs/index.md diff --git a/docs/mkdocs.yml b/mkdocs.yml similarity index 100% rename from docs/mkdocs.yml rename to mkdocs.yml diff --git a/docs/docs_linux.go b/mkdocs_linux.go similarity index 73% rename from docs/docs_linux.go rename to mkdocs_linux.go index 6a1c630e4..c93d25d11 100644 --- a/docs/docs_linux.go +++ b/mkdocs_linux.go @@ -1,3 +1,3 @@ -package docs +package main //go:generate mkdocs build --clean