From 0d12c842458052689850cfb182cf02cceee98913 Mon Sep 17 00:00:00 2001 From: Denperidge Date: Wed, 25 Jan 2023 11:43:03 +0100 Subject: [PATCH] Updated to docs.conf structure --- .gitignore | 3 +++ README.md | 40 ++++++++++++++++++++++++++++++---------- docs.conf.example | 4 ++++ run.sh | 3 +-- 4 files changed, 38 insertions(+), 12 deletions(-) create mode 100644 .gitignore create mode 100644 docs.conf.example diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d434ad9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +divio-docs-gen +docs.conf +tmp/ diff --git a/README.md b/README.md index 1c8303d..138cb16 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,30 @@ -# Divio-Docs-Repo -A template repository to host all your documentation, collected by [divio-docs-gen](https://github.com/Denperidge-Redpencil/divio-docs-gen)! - -## Usage -Simply set the environment variables (through a .env file in this folder, or using your shell) and run `./run.sh`! It can be automated using GH Actions or crontab. -If you want to put the docs in this folder, make sure to set `DOCS=../`. Alternatively, you can use `DOCS=../docs/` to output in a subdirectory. -For more info on the environment variables or what values they should hold, view [divio-docs-gen](https://github.com/Denperidge-Redpencil/divio-docs-gen). - -## License -The code in this repository has been released in the public domain through the [Unlicense](LICENSE). \ No newline at end of file +- [README.md](README.md) +- [run.sh](run.sh) +- [LICENSE](LICENSE) +- [docs.conf.example](docs.conf.example) +- [divio-docs-gen](divio-docs-gen) +- [docs.conf](docs.conf) +- [tmp](tmp) +- [Divio-Docs-Repo](Divio-Docs-Repo) +- [doctest](doctest) +- [ember-data-table](ember-data-table) +- [ember-proxy-service](ember-proxy-service) +- [Learning.md](Learning.md) +- [Matrix-Bot-Starter](Matrix-Bot-Starter) +- [Matrix-Bot-Starter-Starter](Matrix-Bot-Starter-Starter) +- [Mermatrix](Mermatrix) +- [Mermatrix-archive](Mermatrix-archive) +- [mu-cl-resources](mu-cl-resources) +- [mu-dispatcher](mu-dispatcher) +- [mu-docs](mu-docs) +- [mu-identifier](mu-identifier) +- [mu-javascript-template](mu-javascript-template) +- [mu-migrations-service](mu-migrations-service) +- [mu-project](mu-project) +- [mu-ruby-template](mu-ruby-template) +- [mu-search](mu-search) +- [mu-semtech-getting-started](mu-semtech-getting-started) +- [project](project) +- [rarwe-backend](rarwe-backend) +- [semantic-docs](semantic-docs) +- [Sparqlix](Sparqlix) diff --git a/docs.conf.example b/docs.conf.example new file mode 100644 index 0000000..9bb7397 --- /dev/null +++ b/docs.conf.example @@ -0,0 +1,4 @@ +[DEFAULT] +FallbackOwner=Denperidge-Redpencil +GenerateNav=True +DocsBasedir=../ diff --git a/run.sh b/run.sh index 72b0fc9..f175b57 100755 --- a/run.sh +++ b/run.sh @@ -1,5 +1,4 @@ git clone https://github.com/Denperidge-Redpencil/divio-docs-gen.git -cp .env divio-docs-gen/ cd divio-docs-gen -python3 -m pip install -r requirements.txt +cp ../docs.conf . python3 app/index.py