From 6413a4b568665a8218ab3e1c3c1817a0a5d478e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn-Michael=20Miehe?= Date: Tue, 24 Sep 2019 11:53:51 +0200 Subject: [PATCH] example_docs -> examples --- README.md | 2 +- docker-compose.yml | 2 +- .../somedir => examples/automatic directory listing}/.gitignore | 0 .../somedir => examples/automatic directory listing}/Makefile | 0 .../automatic directory listing}/a directory in space/Fishfile | 0 .../automatic directory listing}/a directory in space/Makefile | 0 .../automatic directory listing}/fake latex file.tex | 0 {example_docs => examples}/simple md/.gitignore | 0 {example_docs => examples}/simple md/Makefile | 0 {example_docs => examples}/simple md/simple.md | 0 .../unrelated file.txt => examples/unbuildable file.txt | 0 11 files changed, 2 insertions(+), 2 deletions(-) rename {example_docs/somedir => examples/automatic directory listing}/.gitignore (100%) rename {example_docs/somedir => examples/automatic directory listing}/Makefile (100%) rename {example_docs/somedir => examples/automatic directory listing}/a directory in space/Fishfile (100%) rename {example_docs/somedir => examples/automatic directory listing}/a directory in space/Makefile (100%) rename {example_docs/somedir => examples/automatic directory listing}/fake latex file.tex (100%) rename {example_docs => examples}/simple md/.gitignore (100%) rename {example_docs => examples}/simple md/Makefile (100%) rename {example_docs => examples}/simple md/simple.md (100%) rename example_docs/unrelated file.txt => examples/unbuildable file.txt (100%) diff --git a/README.md b/README.md index 5a43537..d91246d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The `autodoc` image [available on Docker Hub](https://hub.docker.com/r/ldericher 01. Install [Docker CE](https://docs.docker.com/install/) -01. Clone or download the `autodoc` repository, open a terminal inside the [example_docs](https://github.com/ldericher/autodoc/tree/master/example_docs) directory +01. Clone or download the `autodoc` repository, open a terminal inside the [examples](https://github.com/ldericher/autodoc/tree/master/examples) directory 01. Deploy an `autodoc` container: diff --git a/docker-compose.yml b/docker-compose.yml index 606a0c0..426315c 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -14,5 +14,5 @@ services: command: "bash" volumes: - - "${PWD}/example_docs:/docs" - "${PWD}/build/autodoc:/usr/local/bin/autodoc:ro" + - "${PWD}/examples:/docs" diff --git a/example_docs/somedir/.gitignore b/examples/automatic directory listing/.gitignore similarity index 100% rename from example_docs/somedir/.gitignore rename to examples/automatic directory listing/.gitignore diff --git a/example_docs/somedir/Makefile b/examples/automatic directory listing/Makefile similarity index 100% rename from example_docs/somedir/Makefile rename to examples/automatic directory listing/Makefile diff --git a/example_docs/somedir/a directory in space/Fishfile b/examples/automatic directory listing/a directory in space/Fishfile similarity index 100% rename from example_docs/somedir/a directory in space/Fishfile rename to examples/automatic directory listing/a directory in space/Fishfile diff --git a/example_docs/somedir/a directory in space/Makefile b/examples/automatic directory listing/a directory in space/Makefile similarity index 100% rename from example_docs/somedir/a directory in space/Makefile rename to examples/automatic directory listing/a directory in space/Makefile diff --git a/example_docs/somedir/fake latex file.tex b/examples/automatic directory listing/fake latex file.tex similarity index 100% rename from example_docs/somedir/fake latex file.tex rename to examples/automatic directory listing/fake latex file.tex diff --git a/example_docs/simple md/.gitignore b/examples/simple md/.gitignore similarity index 100% rename from example_docs/simple md/.gitignore rename to examples/simple md/.gitignore diff --git a/example_docs/simple md/Makefile b/examples/simple md/Makefile similarity index 100% rename from example_docs/simple md/Makefile rename to examples/simple md/Makefile diff --git a/example_docs/simple md/simple.md b/examples/simple md/simple.md similarity index 100% rename from example_docs/simple md/simple.md rename to examples/simple md/simple.md diff --git a/example_docs/unrelated file.txt b/examples/unbuildable file.txt similarity index 100% rename from example_docs/unrelated file.txt rename to examples/unbuildable file.txt