Commit Graph

24 Commits

Author SHA1 Message Date
Emmanuel Lepage Vallee ac0aeb65c0 doc: Modernize the landing page.
The previous index.html was scary and the most useful links were
at the bottom. This commit fixes that.

It also adds an image of the default config with some labels to name
all visible components.
2021-03-22 00:54:00 -07:00
Emmanuel Lepage Vallee d408ec7846 doc: Use a more compact rendering for method return types. 2020-02-29 21:17:27 -05:00
Emmanuel Lepage Vallee ec7cac5dbf doc: Add a summary next to the property/method title. 2019-11-29 01:26:25 -05:00
Aire-One 46c86351a0 Add ldoc tags for inherited members.
* Add `@inheritedproperty`, `@inheritedmethod` and `@inheritedsignal` ldoc tags to specify inherited members in the documentation,
* These new tags create their own section in the rendered documentation,
* Implemente these tags for `docs/common/object.ldoc` and `docs/common/widget.ldoc`.
2019-11-29 01:26:25 -05:00
Emmanuel Lepage Vallee a3a2fc1344 doc: Hide the newly auto-generated content by default.
First of all, yes, JavaScript in the doc. I don't like this either.

The reason is that the new sections are super useful *when you need
them*. However, in practice, that's rare. So better not make the
signal to noise ratio worst. Future commit will introduce an
auto-generated summary of what's hidden.
2019-11-27 01:44:23 -05:00
Aire-One bc35da73ac Implement inheritance into ldoc template.
This use the new `@baseclass` and `@inherited` tags to add inheritance data to the rendered documentation.
2019-11-27 01:43:07 -05:00
Emmanuel Lepage Vallee 5de1e36007 doc: Use braces for names function arguments.
Use {} for all functions with take `args` as sole parameters instead
of (). Also color them differently to highlight this isn't a typo.
2019-10-01 02:03:12 -04:00
Emmanuel Lepage Vallee 3e3a298a33 doc: Shape the methods and functions arguments in the summary.
Given the full prototype can be quite long with all the optional
argument definition, better help the eyes focus on the important
part.
2019-06-08 18:14:14 -04:00
Emmanuel Lepage Vallee 12a7236e2b doc: Add support for property types to ldoc.
Rather that abusing of how the arguments are displayed to convey the
type, add native support.

It still uses the @param for the doc, so this doesn't cause a million
little noisy changes, but the rendered HTML now have a real section for
the type. This is added to both the summary and the expanded description.

Additionally, if the type has a description string, a second is added.
2019-06-08 18:14:14 -04:00
Emmanuel Lepage Vallee 6ce4fa6802 doc: Remove the old module alias hack.
The module names for also have their alias. The commit also remove 2
deprecated module that were forgotton in the previous "get rid of the
deprecated modules in the doc" PR.
2019-06-08 18:13:42 -04:00
Emmanuel Lepage Vallee bb357dd33e doc: Restore the example width limit to fit in 1024x768.
The old stylesheet did this and it forced the examples to be smaller.

This commit restore this limit.
2018-10-12 14:19:25 -04:00
Emmanuel Lepage Vallee cd6979618f doc: Update the CSS to support our custom table class
Other change:

 * Use GitHub style <code> border
 * Add support for HTML <kbd> tags
2018-10-12 14:19:25 -04:00
Yauhen Kirylau 4bd5b1940d feat(themes; beautiful): add partial support for GTK+3 themes (#2129) 2018-06-26 10:43:20 -04:00
Emmanuel Lepage Vallee f234dcabf6 doc: Add `[deprecated]` after some function names.
It use a little XSS-ish HTML tag injection, but it works
2018-05-28 14:11:41 -04:00
actionless 98e59225d7 chore(ldoc: css): return bullets style for unordered list items 2018-03-20 17:50:39 +00:00
actionless bdbc11e7df style(ldoc: css): apply some manual code formatting 2018-03-20 17:50:39 +00:00
actionless d5d46a4373 fixup! chore(ldoc: css): new style for the tables 2018-03-20 17:50:39 +00:00
actionless 8762588082 fixup! chore(ldoc: css): new style for the tables 2018-03-20 17:50:39 +00:00
actionless 0a6f3aa3da fixup! chore(ldoc: css): new style for the tables 2018-03-20 17:50:39 +00:00
actionless dafbd48375 chore(ldoc: css): new style for the tables 2018-03-20 17:50:39 +00:00
Daniel Hahler fb93003cc5 docs/ldoc.css: just use system fonts 2017-10-28 00:08:31 +02:00
Daniel Hahler 5c9bc988bb navigation: less margin to the left 2017-10-28 00:08:31 +02:00
Daniel Hahler 102e1046b9 add our logo 2017-10-28 00:08:31 +02:00
Daniel Hahler b291880fa1 add css
Source: https://github.com/stevedonovan/LDoc/pull/287
https://raw.githubusercontent.com/hishamhm/LDoc/7214818f0ff580e5607a4de764340aa7e3b55d1a/ldoc/html/ldoc_new_css.lua
2017-10-28 00:08:28 +02:00