From 8ea6869ba95d137b73ebf3e4444c50e6c1d327f2 Mon Sep 17 00:00:00 2001 From: mpourmpoulis <35875229+mpourmpoulis@users.noreply.github.com> Date: Wed, 8 Jul 2020 22:52:47 +0300 Subject: [PATCH 1/2] first attempt for rtd --- .readthedocs.yml | 14 ++++++++++++++ mkdocs.yaml | 25 +++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 .readthedocs.yml create mode 100644 mkdocs.yaml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..38ba770 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,14 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation with MkDocs +mkdocs: + configuration: mkdocs.yml + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: all + diff --git a/mkdocs.yaml b/mkdocs.yaml new file mode 100644 index 0000000..8acb290 --- /dev/null +++ b/mkdocs.yaml @@ -0,0 +1,25 @@ +extra_css: +- https://assets.readthedocs.org/static/css/badge_only.css +- https://assets.readthedocs.org/static/css/readthedocs-doc-embed.css +extra_javascript: +- readthedocs-data.js +- https://assets.readthedocs.org/static/core/js/readthedocs-doc-embed.js +- https://assets.readthedocs.org/static/javascript/readthedocs-analytics.js +google_analytics: null +site_name: PythonVoiceCodingPlugin +site_author: mpourmpoulis +site_url: https://PythonVoiceCodingPlugin.readthedocs.io +docs_dir: doc +repo_url: https://github.com/mpourmpoulis/PythonVoiceCodingPlugin +edit_uri: tree/master/doc + +theme: + name: readthedocs + +nav: + - Home: README.md + - Argument queries: SelectArgument.md + - Big ROI queries: SelectBigROI.md + - SubIndexing: SubIndexing.md + - Operations: Operations.md + - Collections: CollectionQueries.md From 5fab39a6e44c644eec8f501e2b86026118346e4c Mon Sep 17 00:00:00 2001 From: mpourmpoulis <35875229+mpourmpoulis@users.noreply.github.com> Date: Wed, 8 Jul 2020 23:01:03 +0300 Subject: [PATCH 2/2] Update mkdocs.yaml --- mkdocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yaml b/mkdocs.yaml index 8acb290..db3eab4 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -8,7 +8,7 @@ extra_javascript: google_analytics: null site_name: PythonVoiceCodingPlugin site_author: mpourmpoulis -site_url: https://PythonVoiceCodingPlugin.readthedocs.io +site_url: https://pythonvoicecodingplugin.readthedocs.io docs_dir: doc repo_url: https://github.com/mpourmpoulis/PythonVoiceCodingPlugin edit_uri: tree/master/doc