Maximilian Krög
f9ffd75132
dd / dt tag must be inside dl tags
2020-08-23 16:15:50 +02:00
Maximilian Krög
b33b2ce9a4
Don't generate empty nameContainer tag
2020-08-23 16:08:14 +02:00
Maximilian Krög
411d5bfb03
Charset meta tag should be in the first 1024 bytes
2020-08-23 16:08:14 +02:00
Maximilian Krög
477c331a4c
Create source code links during apidoc creation
2020-08-23 16:08:14 +02:00
Maximilian Krög
d9bc466f43
Better scroll behaviour for apidocs
2020-08-23 11:18:19 +02:00
Maximilian Krög
5e30b15860
Fix link to workshop / download
2020-08-04 21:47:58 +02:00
Maximilian Krög
e723061f9b
Add empty alt tag to logo
2020-07-26 19:31:57 +02:00
Andreas Hocevar
2b23052d23
Mark active nav item
2020-07-26 17:41:16 +02:00
Andreas Hocevar
f70374e453
Make header and menu navigation consistent with web site
2020-07-26 17:15:49 +02:00
jeanpierre
9616dee9f7
Update bootstrap, cleanup css, make pages more responsive
2020-07-23 12:32:27 +02:00
MoonE
353de14624
Update config/jsdoc/api/template/tmpl/navigation.tmpl
...
Co-authored-by: Andreas Hocevar <andreas.hocevar@gmail.com >
2020-07-17 16:17:07 +02:00
Maximilian Krög
434ac3141f
Allow line breaks before slashes in apidoc navigation
2020-07-16 21:51:29 +02:00
Andreas Hocevar
5fdf50c1de
No autocomplete for api search field
2020-05-29 08:51:59 +02:00
Maximilian Krög
b07f96e558
Remove link for fullscreen event from navigation
2020-04-10 19:07:25 +02:00
Andreas Hocevar
dd44ecf185
Only document enums when they have API properties
2020-03-28 14:17:56 +01:00
Maximilian Krög
bf2a7bd21a
Allow toggel on whole title, add toggle transition
2020-02-22 01:07:41 +01:00
Maximilian Krög
ee8ec6f03a
Shorter css paths in navigation
2020-02-21 22:58:05 +01:00
Maximilian Krög
2dec296aae
Use css to show / hide items; track matched items
...
... to improve search speed.
Instead of marking all items as hidden, and then marking the matched
ones again, this keeps track of all matched items and only
removes those that no longer match and adds those that previously did
not match.
2020-02-21 22:57:53 +01:00
Maximilian Krög
1b4ed08bc5
Indent line-wrapped class names
2020-02-21 22:55:32 +01:00
Maximilian Krög
cc561dab8e
Allow word wrap before '.' and '~' in class names
2020-02-21 22:55:32 +01:00
Maximilian Krög
7640bcd163
Only match the displayed name of items when searching
...
Currently the search term is matched against the longname of members.
Because of this most members are matched when searching for a
class / module and also searching for 'mod' matches everything as
all longnames start with 'module:'
2020-02-21 22:55:32 +01:00
Maximilian Krög
f7871d6103
Store search data in lowercase and compare in lowercase
...
This way we can do the search case-sensitive after only converting
the search term to lowercase.
2020-02-21 22:55:32 +01:00
Andreas Hocevar
32238806a6
Merge pull request #10617 from MoonE/apidoc-performance
...
Improve apidoc generation performance
2020-02-13 11:03:02 +01:00
Maximilian Krög
300cc282e4
Generate valid html for the apidoc navigation
...
Only `<li>` can be a direct descendant of `<ul>` tags.
2020-02-10 00:10:05 +01:00
Maximilian Krög
5d922fc53b
Cleanup navigation.tmpl and the generated html
...
- Add a function that is used to generate all four types of member lists.
- Only use one line per list item.
- Don't generate empty `class=""` attributes when item is stable.
- Remove closing `</li>` tag, as is allowed by the html 5 standard.
Overall this reduces the filesize for the generated html pages by ~33%.
2020-02-10 00:09:33 +01:00
Maximilian Krög
0c04293d5f
Generate navigation html only once for all pages.
...
This reduces the time for apidoc generation by ~30%.
2020-02-07 00:08:07 +01:00
Maximilian Krög
9622a8ca93
Fix link in apidocs to ObjectEvent.
2019-12-27 23:35:19 +01:00
Tim Schaub
76333f72ba
Merge pull request #10204 from tschaub/doc-layout
...
Avoid scrolling over navigation
2019-10-27 17:05:39 -06:00
Tim Schaub
0f87df0ade
Add the default to the type column
2019-10-26 17:27:04 -06:00
Tim Schaub
1c21853269
Avoid scrolling over navigation
2019-10-26 16:56:14 -06:00
Tim Schaub
27cbbaf97b
Less jumpy
2019-10-26 12:30:38 -06:00
Tim Schaub
c0831cc64b
Carbon add on API docs
2019-10-26 11:11:04 -06:00
Tim Schaub
10379920d2
Avoid toggling when clicking the title
2019-10-23 10:26:21 -06:00
Andreas Hocevar
4fe16d0281
Tidy up navigation
2019-10-23 13:26:56 +02:00
Kai Volland
3cb0aae796
Removes modulelink
2019-10-08 10:12:29 +02:00
Kai Volland
5786121cd5
Adapts linktext to module
2019-10-07 09:50:14 +02:00
Kai Volland
d08c0baff9
Introduces apidoc changes
...
- Removes modules from the apidoc navigation
- Adds a weight paramater to the search to be
more accurate on searchresults
2019-09-27 17:25:01 +02:00
ahocevar
8d793ad6ec
List complete classes in doc navigation
2019-06-17 13:10:02 +02:00
ahocevar
d059689856
Index classes under modulues
2019-06-17 08:15:49 +02:00
Kai Volland
9860699d5f
Introduces import snippets for static functions
...
Adds snippets for import of modules and their
exported functions to the API documentation.
2019-04-04 10:07:55 +02:00
ahocevar
56a60631bc
Allow users to opt out of tracking
2019-01-02 07:36:25 +01:00
ahocevar
b50749e1ea
Use jsdoc-plugin-typescript
2018-10-29 19:15:01 +01:00
ahocevar
453a723005
Improve link handling in API docs
2018-10-24 17:52:42 +02:00
ahocevar
724d141d3a
Fix links and navigation
2018-10-23 18:05:02 +02:00
ahocevar
0b21d1a6fc
Document anonymous default exports
2018-10-23 18:01:46 +02:00
Tim Schaub
d8b290966b
Tracking
2018-07-21 09:11:30 -06:00
ahocevar
e810387956
Fix some JSDoc issues
...
Also makes a few minor changes to the template, so it can be used until
we have a new doc generation process. JSDoc output is written to
build/apidoc.
2018-05-10 17:14:17 +02:00
Andreas Hocevar
86d0074386
Print ES6 import hint on each doc page
2017-08-15 19:17:06 -04:00
Andreas Hocevar
b3ddcd4ed9
Avoid duplicates in Observables list
2017-06-12 08:24:44 +02:00
Tim Schaub
f5aea97d3b
All @api annotations imply stability
2017-02-06 09:22:05 -07:00
