From 7607db8aaa352ab15d5db9bcc26171a077d2ce5e Mon Sep 17 00:00:00 2001 From: Kees van den Broek Date: Fri, 12 Apr 2019 07:24:56 +0200 Subject: [PATCH 1/4] chore: remove failing dependency inline graphviz seems to be causing mkdocs to fail building the docs --- mkdocs.yml | 1 - requirements.txt | 1 - 2 files changed, 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index b2583b7..4747be0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -55,7 +55,6 @@ use_directory_urls: false strict: true markdown_extensions: - - inline_graphviz - toc: anchorlink: True - admonition diff --git a/requirements.txt b/requirements.txt index e72a723..1cc0e5f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1 @@ -markdown-inline-graphviz == 1.0 mkdocs == 0.16.0 From fda552cdb74f7fe4685eaab94f30d54899554a50 Mon Sep 17 00:00:00 2001 From: Kees van den Broek Date: Fri, 12 Apr 2019 07:28:54 +0200 Subject: [PATCH 2/4] chore: bump mkdocs to version 1.0.4 --- mkdocs.yml | 2 +- requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 4747be0..288e00c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ site_name: ITSLanguage API repo_url: https://github.com/itslanguage/itslanguage-docs/ copyright: 2013-2018 -pages: +nav: - Home: - 'ITSLanguage Speech API': 'index.md' - REST API basics: diff --git a/requirements.txt b/requirements.txt index 1cc0e5f..d233602 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1 @@ -mkdocs == 0.16.0 +mkdocs == 1.0.4 From 344349110a99679f582e27831783fe91ad675570 Mon Sep 17 00:00:00 2001 From: Kees van den Broek Date: Fri, 12 Apr 2019 07:33:23 +0200 Subject: [PATCH 3/4] docs: make the welcome page a bit more useful --- docs/index.md | 7 +++++-- mkdocs.yml | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index 4d77ef3..d666b15 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,10 @@ ## Welcome -This is a work-in-progress help site for ITSLanguage. +This website contains the REST API documentation for ITSLanguage. +It's what you need when you're building an integration of ITSLanguage into your backend. + +In case you're looking for integration of ITSLanguage in your frontend, please take a look at our JS SDK. ## Improving This Help -Just drop us an email. +Just drop us an email. diff --git a/mkdocs.yml b/mkdocs.yml index 288e00c..5797a5a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: ITSLanguage API repo_url: https://github.com/itslanguage/itslanguage-docs/ -copyright: 2013-2018 +copyright: 2013-2019 nav: - Home: - 'ITSLanguage Speech API': 'index.md' From c495c418d00de1b275e0cb8e9a1578af179b0e75 Mon Sep 17 00:00:00 2001 From: Kees van den Broek Date: Fri, 12 Apr 2019 07:35:19 +0200 Subject: [PATCH 4/4] chore: the graphviz dep is unused --- .travis.yml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index 2035592..19dfd74 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,11 +7,7 @@ env: global: - COMMIT_AUTHOR_NAME: ITSLanguage Bot - COMMIT_AUTHOR_EMAIL: its-bot@itslanguage.nl - - SITE_DIR: $TRAVIS_BUILD_DIR/.site - -before_install: - - sudo apt-get -qq update - - sudo apt-get install -y graphviz + - SITE_DIR: $TRAVIS_BUILD_DIR/.site after_success: # Failing will "fail" the build