Docs: adding first version of the auto-generated packages API docs. (#22107)

* 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 menu options.

* added parameters and return values.

* Fixed merge error.

* Added first version of auto-generated docs.

* 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.

* updated api docs.

* lerna bootstrap.

* added eror to the ingore words list.

* removed file that should be ignored.

* updated locKFILE.

* referenced the code comments guidelines.

* updated packages.

* updated deps.

* updated the autogenerated dosc.

* adding missing new line.

This commit is contained in:

Marcus Andersson

2020-02-26 10:03:53 +01:00

committed by

GitHub

parent 89e6c45090

commit 6bc369629d

594 changed files with 30265 additions and 1 deletions

									
										docs/sources/menu.yaml
									
		+11
		
												View File
												
				@@ -343,6 +343,17 @@

				    link: /http_api/team/

				  - name: Users

				    link: /http_api/user/

				- name: SDK Reference

				  link: /packages_api/

				  children:

				  - name: "@grafana/data"

				    link: /packages_api/data/

				  - name: "@grafana/e2e"

				    link: /packages_api/e2e/

				  - name: "@grafana/runtime"

				    link: /packages_api/runtime/

				  - name: "@grafana/ui"

				    link: /packages_api/ui/

				- name: Developers

				  link: /developers/

				  children: