opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-31 22:42:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: adding API reference documentation support for the packages libraries. (#21931)

Browse Source 
* trying out api-extractor.

* works with our setup of build.

* wip.

* changed the packages so it works better with the api-extractor.

* Changes to make the api-extractor to work.

* cleaned up the api-extractor config files.

* added some more documentation.

* added tsdoc-metadata to gitignore.

* removed the generated docs (will do that in another PR).

* added execute permission to script for generating dosc.

* added so we will push generated docs to branch.

* will clean packages_api on abort.

* Fixed failing tests.

* fixed formatting issue with typedoc comment.

* temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved

* temporary enabled bable namespaces.

* updated build script.

* updated script.

* updated script with some colors.

* changed to camelCase.

* removed spacing.

* Starting to add documentation guidelines.

* added examples headline.

* added parameters and return values.

* Fixed merge error.

* changed so we use the eslint ignore syntax.

* changed to correct eslint ingnore comment.

* fixed some spelling errors reported by codespell.

* added script to generate docs in current folder.

* lerna bootstrap.

* removed file that should be ignored.

* updated locKFILE.

* referenced the code comments guidelines.

* updated packages.

* updated deps.
This commit is contained in:
Marcus Andersson
2020-02-25 13:59:11 +01:00
committed by GitHub
parent 002d2119fd
commit e2038e0614
39 changed files with 910 additions and 400 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
scripts/build_api_docs.sh Executable file
View File

@ -0,0 +1,27 @@
#!/usr/bin/env bash
# abort if we get any error
set -e
# always make sure we have a clean workspace
if ! git diff-index --quiet HEAD --; then
echo -e "\033[91mgit workspace is dirty and contains changes\033[0"
echo -e "\033[91mmake sure you have a clean workspace before running this script\033[0m"
exit 1
fi
# building grafana packages
echo "bulding grafana packages..."
yarn packages:build
# extract packages api documentation json
echo "extracting packages documentation data..."
yarn packages:docsExtract
# generating api documentation markdown
echo "generating markdown from documentation data..."
yarn packages:docsToMarkdown
# cleaning packages
echo "cleaning up packages build files..."
lerna run clean