From 6457fe84cd60a6c9570af5212135f1a8ba18f63d Mon Sep 17 00:00:00 2001 From: Nicolas CARPi <3043706+NicolasCARPi@users.noreply.github.com> Date: Fri, 17 Sep 2021 23:34:08 +0200 Subject: [PATCH] remove sample forms from apidoc (#13507) * remove sample forms from apidoc * add explicit path to config for apidoc * bring all apidoc files into apidoc folder --- .gitignore | 2 +- apidoc.json => apidoc/apidoc.json | 1 + apidoc/header.md | 3 --- gulp/gulp-apidoc.js | 4 +++- 4 files changed, 5 insertions(+), 5 deletions(-) rename apidoc.json => apidoc/apidoc.json (91%) diff --git a/.gitignore b/.gitignore index 30acf874b2..f3ead07d99 100644 --- a/.gitignore +++ b/.gitignore @@ -5,7 +5,7 @@ website/common/transpiled-babel/ node_modules content_cache i18n_cache -apidoc_build +apidoc/html *.swp .idea* config.json diff --git a/apidoc.json b/apidoc/apidoc.json similarity index 91% rename from apidoc.json rename to apidoc/apidoc.json index 0833e9b4db..8b2893529d 100644 --- a/apidoc.json +++ b/apidoc/apidoc.json @@ -2,6 +2,7 @@ "name": "Habitica V3 API Documentation", "title": "Habitica", "url": "https://habitica.com", + "sampleUrl": null, "header": { "title": "Introduction", "filename": "apidoc/header.md" diff --git a/apidoc/header.md b/apidoc/header.md index f870a900b3..9f9ac90831 100644 --- a/apidoc/header.md +++ b/apidoc/header.md @@ -3,6 +3,3 @@ This webpage includes the documentation for version 3 of the [Habitica](https://habitica.com) API. If you're developing a 3rd party tool that uses the Habitica API you should read the [Guidance for Comrades](https://habitica.fandom.com/wiki/Guidance_for_Comrades) and in particular the section called [Rules for Third-Party Tools](https://habitica.fandom.com/wiki/Guidance_for_Comrades#Rules_for_Third-Party_Tools) which includes suggestions on how to best use the API and the rules to follow when interacting with it. - -# Attention: Sample forms are non-functional -The sample forms were enabled [due to a change in the apidoc package](https://github.com/apidoc/apidoc/pull/915) and do not function, they will be disabled in a future release. diff --git a/gulp/gulp-apidoc.js b/gulp/gulp-apidoc.js index 55709fbdc2..0b15f65fa6 100644 --- a/gulp/gulp-apidoc.js +++ b/gulp/gulp-apidoc.js @@ -2,8 +2,9 @@ import gulp from 'gulp'; import clean from 'rimraf'; import apidoc from 'apidoc'; -const APIDOC_DEST_PATH = './apidoc_build'; +const APIDOC_DEST_PATH = './apidoc/html'; const APIDOC_SRC_PATH = './website/server'; +const APIDOC_CONFIG_PATH = './apidoc/apidoc.json'; gulp.task('apidoc:clean', done => { clean(APIDOC_DEST_PATH, done); }); @@ -12,6 +13,7 @@ gulp.task('apidoc', gulp.series('apidoc:clean', done => { const result = apidoc.createDoc({ src: APIDOC_SRC_PATH, dest: APIDOC_DEST_PATH, + config: APIDOC_CONFIG_PATH, }); if (result === false) {