Commit Graph

162 Commits

Author SHA1 Message Date
Steve J Donovan 9cd29253cb Merge pull request #233 from JojoBoulix/Honour-SOURCE_DATE_EPOCH
Honour the SOURCE_DATE_EPOCH environment variable
2016-06-19 11:11:40 +02:00
Steve J Donovan 0d9768e86d Merge pull request #223 from thehunmonkgroup/custom-css-config
add custom_css configuration param
2016-06-18 17:38:39 +02:00
steve donovan bbbcb1a59f --fatalwarnings flag to force ldoc to return non-zero exit code if there are any warnings; issue #255 @psychon 2016-04-10 18:02:09 +02:00
JojoBoulix 707484790e Honour the SOURCE_DATE_EPOCH environment variable
When the environment variable SOURCE_DATE_EPOCH is set, use it as the epoch of the date to be written in the output.
This allows to build reproducibly packages depending on LDoc to build their documentation, without any change to their code and build process.
See https://reproducible-builds.org/specs/source-date-epoch/
2016-04-06 22:18:27 +02:00
Chad Phillips d8ff44f626 add custom_css configuration param. 2015-12-30 21:32:21 -05:00
Steve Donovan 299e82a9d3 Issue #210: custom --date for reproducible builds 2015-09-28 15:53:48 +02:00
Steve Donovan b248a2e035 Modifications to pull #207; enable backward compatibility and fixed spelling mistake 2015-09-28 15:33:18 +02:00
Jaroslav Vaculik 9f6c84f8bc Using ldoc.prettify_files the same way as for example ldoc.examples 2015-07-24 17:18:13 +02:00
Steve J Donovan 3d193b169f Merge pull request #188 from mooffie/postprocess_html
Have postprocess_html
2014-12-26 17:11:45 +02:00
Mooffie 22e7055f03 Have postprocess_html 2014-12-24 17:51:05 +02:00
Mooffie a985fd4c4b Show exact error when template loading fails 2014-12-21 18:31:44 +02:00
Mooffie 3313e78b44 Support used-defined keywords (in prettified code). 2014-12-15 10:05:50 +02:00
steve donovan 4ab5f07d84 1.4.3 release patches 2014-11-03 18:50:29 +02:00
Steve Donovan c23e2a9b6f changed prettify keyword colour to make it more distinct from link; pushed up <code> size; cleaned up style-sheet-found-error 2014-10-28 15:40:32 +02:00
steve donovan c516eebd12 version bump; underscore escaping fix for backticks; horrible workaround for deficiencies of C lexer 2014-10-25 12:01:48 +02:00
steve donovan 5230010a37 issue #181: all option to show locals did not work in config.ld 2014-10-16 18:48:52 +02:00
steve donovan 56ac2601c0 Tweaks to opt/optchain: (optional) is emitted after optional arguments without defaults. convert_opts (counter-intuitively) disables automatic opt->optchain promotion 2014-10-12 16:45:09 +02:00
steve donovan cfdc6f8f53 new feature: prettify_files makes per-item links to source; unless this field is 'show', don't put in index 2014-10-12 16:09:09 +02:00
hanxi bf11db2380 add update time to the page footer 2014-09-10 10:39:17 +08:00
Steve Donovan 7b496aa05b accept examples written in any language supported by LDoc 2014-06-20 15:08:11 +02:00
steve donovan 8b2b2e4625 #159 directory as argument case was broken 2014-05-25 14:11:00 +02:00
Steve Donovan 624ff11afd parameter names which were List methods overwriting object - factor out as map field 2014-04-23 13:19:16 +02:00
Steve Donovan 251dc88f93 deterministic ordered file processing 2014-04-23 10:20:55 +02:00
steve donovan 511dfe7df0 ldoc.custom_references to create new @{KIND:NAME} reference schemes; doc updates 2014-01-21 19:51:55 +02:00
steve donovan b09f7f865f unknown typename check for kind_names; updated ldoc's config.ld 2014-01-18 16:13:15 +02:00
Steve Donovan e5605a4a94 kind_names variable can override names used in sidebar, e.g. 'kind_names={topic='Manual'}' will override default of 'Topics' 2014-01-17 15:59:39 +02:00
Steve Donovan 2c0d459a43 bumped version to 1.4.2 2014-01-16 09:53:29 +02:00
steve donovan 86a3fde07e issue #139; improved lookup for class methods; args override now only kicks if the argument does not have its default value 2014-01-05 14:55:20 +02:00
steve donovan f507e36720 more general method of controlling visibility of local functions or items marked with @local 2014-01-02 18:45:04 +02:00
Dirk Feytons b16e85af7d Fix issue #123: override 'boilerplate' was done too late 2013-12-24 11:30:56 +01:00
Hisham Muhammad 9b40e03e3a Command-line flags that were explicitly passed by the user should take precedence over config file defaults. 2013-12-21 00:41:41 -02:00
Mooffie 3053079fee Custom display_name handler. 2013-12-09 12:23:27 +02:00
abadc0de 89854e1537 Custom tags
Custom tags
2013-11-28 10:46:59 -05:00
Steve Donovan 63e3618c05 Issue #110; use '-u' or 'unqualified' explicitly to strip package names on sidebar (thanks to abadc0de) 2013-11-27 09:50:38 +02:00
Steve Donovan 8081e5b43c option to use Markdown titles instead of file names with 'use_markdown_titles' (otherwise drop the .md extension on display) 2013-11-18 10:26:40 +02:00
steve donovan 9fc5697cff Issue #108: sorting modules etc is off by default, switch back on using 'sort_modules=true'. Section lookup in docs was borked, fixed by stripping any extra whitespace before section titles 2013-11-17 10:38:24 +02:00
steve donovan 4666e464cc no more fooling with globals in LDoc; the class ModuleMap is no longer global, but inserted into doc module so it can use it 2013-11-16 21:03:43 +02:00
steve donovan fd323aa286 Issue #105; can switch off auto-linking to Lua manual with 'no_lua_ref' variable. This also happens if plain C documentation is being generated 2013-11-16 20:36:53 +02:00
Steve Donovan d2e40e2f2f basic support for documenting C. If you put 'parse_extra={C=true}' in config.ld, then it will attempt to extract function name, arguments and types from the source 2013-09-20 13:33:06 +02:00
Steve Donovan df72613e57 structure return needs 'typename'; by default merge_error_groups will combine different error tag texts 2013-08-27 12:47:47 +02:00
Steve Donovan 0d79e16706 PL utils.unpack compatibility; refactoring error 'tag' 2013-08-26 09:59:10 +02:00
steve donovan 7da46268dc 'pale' template added; interpretation of --style and --template extended 2013-08-25 19:38:01 +02:00
steve donovan ad909d683b Can prettify C files as well as Lua with built-in prettifier 2013-08-25 14:29:30 +02:00
steve donovan 45cb21bcc1 try harder with -m to resolve methods 2013-08-24 15:39:41 +02:00
steve donovan 3c72ea112e ldoc.alias can specify a function which must return tag, value, modifiers like Item:check_tag. The alias error works with return groups 2013-08-24 15:19:45 +02:00
steve donovan 9af4bae066 return groups; experimental 'error' tag 2013-08-24 13:21:41 +02:00
Steve Donovan 70eaf2be6f bumped to 1.4.0; doc updates and formatting 2013-08-23 13:50:34 +02:00
Steve Donovan 3c72e9e4d1 fix issue #80, backticks expand in copyright and other 'info' tags. format='backtick' (-f backtick) is like format='plain' but with implicit 'backtick_references=true'. -X is short for 'not_luadoc' 2013-08-22 09:43:26 +02:00
Steve Donovan dfdac3f977 fix #84; also no_space_before_args=false to stop ldoc putting space between name and arglist of functions 2013-08-20 15:26:49 +02:00
Steve Donovan 52e9b6f32c new classmod tag for defining modules that just export one class (experimental) 2013-08-07 15:19:46 +02:00