krikkert/habitica
1
0
Fork 0
mirror of https://github.com/HabitRPG/habitica.git synced 2025-12-16 14:17:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

remove sample forms from apidoc (#13507)

Browse Source 
* remove sample forms from apidoc

* add explicit path to config for apidoc

* bring all apidoc files into apidoc folder
This commit is contained in:
Nicolas CARPi
2021-09-17 23:34:08 +02:00
committed by GitHub
parent c5b0833bf2
commit 6457fe84cd
4 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@@ -5,7 +5,7 @@ website/common/transpiled-babel/
node_modules node_modules
content_cache content_cache
i18n_cache i18n_cache
apidoc_build apidoc/html
*.swp *.swp
.idea* .idea*
config.json config.json

1
apidoc.json → apidoc/apidoc.json
View File

@@ -2,6 +2,7 @@
"name": "Habitica V3 API Documentation", "name": "Habitica V3 API Documentation",
"title": "Habitica", "title": "Habitica",
"url": "https://habitica.com", "url": "https://habitica.com",
"sampleUrl": null,
"header": { "header": {
"title": "Introduction", "title": "Introduction",
"filename": "apidoc/header.md" "filename": "apidoc/header.md"

3
apidoc/header.md
View File

@@ -3,6 +3,3 @@
This webpage includes the documentation for version 3 of the [Habitica](https://habitica.com) API. 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. 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.

4
gulp/gulp-apidoc.js
View File

@@ -2,8 +2,9 @@ import gulp from 'gulp';
import clean from 'rimraf'; import clean from 'rimraf';
import apidoc from 'apidoc'; import apidoc from 'apidoc';
const APIDOC_DEST_PATH = './apidoc_build'; const APIDOC_DEST_PATH = './apidoc/html';
const APIDOC_SRC_PATH = './website/server'; const APIDOC_SRC_PATH = './website/server';
const APIDOC_CONFIG_PATH = './apidoc/apidoc.json';
gulp.task('apidoc:clean', done => { gulp.task('apidoc:clean', done => {
clean(APIDOC_DEST_PATH, done); clean(APIDOC_DEST_PATH, done);
}); });
@@ -12,6 +13,7 @@ gulp.task('apidoc', gulp.series('apidoc:clean', done => {
const result = apidoc.createDoc({ const result = apidoc.createDoc({
src: APIDOC_SRC_PATH, src: APIDOC_SRC_PATH,
dest: APIDOC_DEST_PATH, dest: APIDOC_DEST_PATH,
config: APIDOC_CONFIG_PATH,
}); });
if (result === false) { if (result === false) {