cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

build(docs-infra): display github links in CLI API docs (#26515)

Browse Source 
This commit includes the following changes:

* CLI version information is read from the CLI package from which
  we read the help files.
* CLI API pages now contain GH links
* line numbers are not shown in GH links, if the doc does not
  have a truthy `startingLine` value. This allows us to remove
  hard coded checks for `guide` pages
* content pages and CLI api docs no longer have a `startingLine`
* the hard-coded `packages` path segment has been removed from
  the templates; instead we now only use the `realProjectRelativePath`.
* the `realProjectRelativePath` has been updated accordingly for API
  and CLI API docs.

PR Close #26515
This commit is contained in:
Pete Bacon Darwin
2018-10-17 15:45:47 +01:00
committed by Alex Rickabaugh
parent a4fcd07792
commit 4fd9988251
11 changed files with 88 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
aio/tools/transforms/cli-docs-package/readers/cli-command.spec.js
View File

@ -82,11 +82,6 @@ describe('cli-command reader', () => {
]);
});
it('should start at line 1', () => {
const docs = reader.getDocs(fileInfo);
expect(docs[0].startingLine).toEqual(1);
});
it('should extract the short description into the content', () => {
const docs = reader.getDocs(fileInfo);
expect(docs[0].content).toEqual('Add support for a library to your project.');