Matthieu Riegler
16e61f5dd0
docs(docs-infra): Add support for experimental enum entries
2025-11-11 08:46:06 -08:00
Miles Malerba
59635bba34
docs: improve docs generation for namespaces ( #64747 )
...
Improves docs epxerience for interfaces / type aliases that are merged
with a namespace.
PR Close #64747
2025-11-05 22:42:59 +00:00
Miles Malerba
662f0e5c00
feat(docs-infra): add support for namespaces
...
Adds support for generating docs for namespaces (and merged declarations
of namespace + type)
2025-10-29 20:22:21 +00:00
Matthieu Riegler
54636eacca
docs(docs-infra): Extract multiple extends statements for interfaces ( #64539 )
...
fixes #64528
PR Close #64539
2025-10-20 21:18:13 +00:00
Matthieu Riegler
47dc4ffd1a
docs(docs-infra): share markdown rendering and highlighting code between api-gen and guides ( #63357 )
...
This reduces code duplication and improves the maintability.
PR Close #63357
2025-08-25 15:33:55 -07:00
Matthieu Riegler
da06239a41
docs(docs-infra): Add exemption list for linking symbols. ( #63309 )
...
PR Close #63309
2025-08-21 10:05:55 -07:00
Alan Agius
494385cac0
fix(docs-infra): allow wrapping of types-and-default CLI options ( #63211 )
...
This change fixes an issue where long lists of enum values would display on a single line, running off the screen, especially on mobile devices.
PR Close #63211
2025-08-18 12:52:03 +02:00
Alan Agius
1714e9ea0e
fix(docs-infra): display value type in CLI pages ( #63211 )
...
The value type was not being displayed when a value had an enum, which was misleading. This change ensures the value type is always shown, so users know whether to expect a single value or an array of values.
PR Close #63211
2025-08-18 12:52:03 +02:00
Matthieu Riegler
00afc73f67
docs: fix CLI reference layout ( #62609 )
...
fixes #62602
PR Close #62609
2025-07-14 09:59:54 -07:00
Matthieu Riegler
5c54cb87a5
docs: improve support for decorator APIs ( #60411 )
...
The commit introduce the distinction between
- class like decorators (like Component, Interface, NgModule. They are formatted like classes/interfaces, with each attribute being documents.
- function like decorators (Attribute, Host, Optional...)
PR Close #60411
2025-07-03 11:51:34 +00:00
Matthieu Riegler
08e6e7bf37
docs: display deprecation message for top most symbol ( #62427 )
...
For classes, types, functions, enums etc.
fixes #62365
PR Close #62427
2025-07-03 08:35:01 +00:00
Matthieu Riegler
44782beea7
docs(docs-infra): fix & simplify scrolling for code blocks ( #62179 )
...
PR Close #62179
2025-06-23 14:19:34 +02:00
Matthieu Riegler
f1f37896c5
docs(docs-infra): display CLI enum values for enums ( #61521 )
...
fixes #61516
PR Close #61521
2025-05-20 16:54:12 +00:00
Matthieu Riegler
ca700e1def
docs(docs-infra): Improve formatting of functions ( #61154 )
...
The commit introduce prettier to format some API entries.
For now we'll do only functions are other are a bit more complex because of the support of deprecation.
fixes #59211
PR Close #61154
2025-05-16 13:58:35 +00:00
Joey Perrott
5f1c08d75f
build: migrate adev shared-docs package to use ts_project ( #61193 )
...
Migrate the build rules for shared docs to use ts_project
PR Close #61193
2025-05-09 16:30:05 +00:00
Miles Malerba
47e44c8af0
docs: update rendering to use generated repo link ( #61130 )
...
PR Close #61130
2025-05-06 14:07:32 -07:00
Matthieu Riegler
f580318411
docs(docs-infra): Add version of introduction for APIs ( #60814 )
...
For new APIs we'll mention since when a particular API is in its current status (experimental, devPreview, stable)
fixes #49668
PR Close #60814
2025-05-02 07:51:33 -07:00
hawkgs
d8204bf584
docs(docs-infra): fix function api ref header width ( #61022 )
...
Fix the width of the function API reference header when the viewport width is for-desktop-down.
PR Close #61022
2025-04-28 10:01:40 -07:00
hawkgs
3e293535e3
docs(docs-infra): use a custom scrollbar for the examples using HighlightTypeScript ( #60981 )
...
The examples used to render the native scrollbar.
PR Close #60981
2025-04-23 17:24:29 +02:00
Matthieu Riegler
c990265473
docs(docs-infra): Improve doc support for pipes. ( #60926 )
...
This commits adds the pipe usage and the impure pipe mention.
PR Close #60926
2025-04-23 08:46:11 +02:00
Matthieu Riegler
ba94f6f84f
docs(docs-infra): hide github link for external repos. ( #60114 )
...
fixes #60113
PR Close #60114
2025-03-04 17:02:37 +00:00
hawkgs
ea5b7371e5
docs(docs-infra): fix card highlighting in the API reference details page ( #59965 )
...
Drop `pointer-events: none` and update the member card highlighting mechanism.
PR Close #59965
2025-02-18 14:56:48 +00:00
hawkgs
b6733eeea4
docs(docs-infra): drop tabs layout from the API reference details page ( #59068 )
...
Drop the tabs in favor of a single page separated by sections.
PR Close #59068
2025-02-13 14:58:33 +00:00
Matthieu Riegler
fd073004bb
docs(docs-infra): fix entry labels. ( #59384 )
...
fixes #59382
PR Close #59384
2025-01-08 15:22:43 +00:00
Matthieu Riegler
139f61913c
docs: remove data attributes from api-item-label ( #59273 )
...
Perf measurments have revealed that `data-*` attributes are slower to set than classes.
PR Close #59273
2025-01-06 16:03:42 +00:00
Matthieu Riegler
f15ccb94b9
docs(docs-infra): enable tslint ( #58961 )
...
PR Close #58961
2024-12-05 16:03:35 -08:00
Alan Agius
c2a9b75045
fix(docs-infra): retain function keyword in API definitions ( #58561 )
...
**Before:**
```ts
animate(
timings: string | number,
styles?: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null
): AnimationAnimateMetadata;
```
**Now:**
```ts
function animate(
timings: string | number,
styles?: AnimationStyleMetadata | AnimationKeyframesSequenceMetadata | null
): AnimationAnimateMetadata;
```
PR Close #58561
2024-11-08 17:16:04 +00:00
Matthieu Riegler
bb0edaded0
docs(docs-infra): Add NgModule exports for directives. ( #58071 )
...
This information is extracted from the @NgModule Jsdoc tag.
fixes #57906
PR Close #58071
2024-10-04 14:46:16 -07:00
Joey Perrott
9dbe6fc18b
refactor: update license text to point to angular.dev ( #57901 )
...
Update license text to point to angular.dev instead of angular.io
PR Close #57901
2024-09-24 15:33:00 +02:00
Matthieu Riegler
49f7179ded
docs(docs-infra): Add dedicated support for decorators. ( #57595 )
...
PR Close #57595
2024-09-19 14:16:31 -07:00
Matthieu Riegler
e3919e7b9d
docs: display property details ( #57622 )
...
In case there are no signatures (like in an bare interface method), we display the implementation information.
PR Close #57622
2024-09-05 17:22:32 +00:00
Matthieu Riegler
b96e75b89a
docs(docs-infra): Improve styling around API pages ( #57492 )
...
PR Close #57492
2024-08-30 11:12:25 -07:00
Matthieu Riegler
55387c5b56
docs(docs-infra): Improve support for deprecated methods ( #57492 )
...
PR Close #57492
2024-08-30 11:12:25 -07:00
Matthieu Riegler
01030d58a7
docs(docs-infra): Add support for cross-links on API pages ( #57346 )
...
PR Close #57346
2024-08-29 13:39:58 -07:00
Matthieu Riegler
e404f88092
docs(docs-infra): show usageNotes only for methods. ( #57343 )
...
Prior to this change, function and methods showed their usage notes which resulted in duplicate displays for functions.
Fixes #57339
PR Close #57343
2024-08-29 07:39:50 -07:00
Matthieu Riegler
04911d7599
docs(docs-infra): Add support for function/method overloads ( #57255 )
...
PR Close #57255
2024-08-13 12:09:01 -07:00
Joey Perrott
3bdead1b2f
refactor(docs-infra): migrate api-gen from dev-infra into the repo ( #57241 )
...
Move the api-gen pipeline into the shared-docs directory.
PR Close #57241
2024-08-05 17:06:29 +00:00