aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen/BuildEncyclopediaProcessor.java
Commit message (Collapse)AuthorAge
* Remove the product name from ConfiguredRuleClassProvider.Gravatar jmmv2017-09-07
| | | | | | | | | | | | | The RuleClassProvider includes a copy of the product name, parameterized for both Blaze and Bazel. Apparently, this is exclusively there so that the standalone docgen binary can "magically" guess the product name. This is strange and adds additional complexity to the Bazel core codebase for no strong reason. Instead, just add a new flag to docgen that takes the product name and pass it in explicitly. RELNOTES: None. PiperOrigin-RevId: 167724033
* Implement generating single-page Build Encyclopedia.Gravatar David Chen2016-08-29
| | | | | | | | | | | | | | * Adds a --single_page flag to the BE docgen for generating a single-page version of the Build Encyclopedia. * Refactor BuildEncyclopediaProcessor common logic into a base class and add subclasses for generating single- and multi-page BE respectively. * Enable RuleLinkExpander to expand rule references to single-page hrefs (headings on the current page). * Update docgen velocity templates to use RuleLinkExpander to ensure links are correct on both single- and multi-page versions of the BE. -- MOS_MIGRATED_REVID=131574793
* Use Options for BE docgen command line arguments.Gravatar David Chen2016-08-16
| | | | | -- MOS_MIGRATED_REVID=130371455
* Do not generate documentation for rule family if it does not contain anyGravatar David Chen2016-02-17
| | | | | | | | | | | | | | documented rules. Currently, we are generating an empty page for the Protocol Buffer rules on bazel.io because the rule definition exists but all the rules are set as undocumented. In cases like these, the docgen should neither generate a page nor any links for the rule family. Fixes #882 -- MOS_MIGRATED_REVID=114834947
* Refactor BuildEncyclopediaProcessor to use a common RuleFamily class for ruleGravatar David Chen2015-12-16
| | | | | | | | | | | | | documentation passed to templates. * This simplifies the logic in BuildEncyclopediaProcessor, reducing the number of various different data structures we use for generating different pages. * This also makes RuleFamily more similar to the BuildLanguage proto, which we we may consider using in the future for the native rule docgen since the Skylark docgen will be using BuildLanguage. -- MOS_MIGRATED_REVID=110265727
* Split Build Encyclopedia into multiple pages.Gravatar David Chen2015-10-23
| | | | | -- MOS_MIGRATED_REVID=106092764
* Support for a black list of documented rulesGravatar Damien Martin-Guillerez2015-09-28
| | | | | | | | | | | Any rule in that black list will be skipped during build encyclopedia generation. This is for supporting outside documentation of rules that have a different documentation internally. -- MOS_MIGRATED_REVID=103958542
* Rationalize copyright headersGravatar Damien Martin-Guillerez2015-09-25
| | | | | | | | | | | The headers were modified with `find . -type f -exec 'sed' '-Ei' 's|Copyright 201([45]) Google|Copyright 201\1 The Bazel Authors|' '{}' ';'` And manual edit for not Google owned copyright. Because of the nature of ijar, I did not modified the header of file owned by Alan Donovan. The list of authors were extracted from the git log. It is missing older Google contributors that can be added on-demand. -- MOS_MIGRATED_REVID=103938715
* Move presentation-specific logic from BE docgen into Velocity templates. MakeGravatar David Chen2015-08-18
| | | | | | | documentation of predefined attributes consistent with new look and feel. -- MOS_MIGRATED_REVID=100905320
* Use Apache Velocity for templating for generating Build Encyclopedia. ↵Gravatar David Chen2015-06-26
| | | | | | | | | | | | | Refactor code used for extracting documentation from rule classes into separate class. Todo after this CL: * Use RuleDocumentation and RuleDocumentationAttribute directly in .vm templates to further simplify BuildEncyclopediaProcessor code * Use VTL #include for including common attribute documentation * Split BE into multiple pages * Use templating for Skylark Library -- MOS_MIGRATED_REVID=96865477
* Improve readability of Build Encyclopedia summary table on bazel.io.Gravatar David Chen2015-06-19
| | | | | | | Add Bootstrap styles to all tables on Test Encyclopedia for bazel.io. -- MOS_MIGRATED_REVID=96388455
* Fix Build Encyclopedia docgen: allow overriding rule definitions.Gravatar Laszlo Csomor2015-03-13
| | | | | | | | This is important if a base rule definition is available but the specific rule class wants to override it. -- MOS_MIGRATED_REVID=88533474
* Make the BE docgen's code a bit nicer.Gravatar Laszlo Csomor2015-03-10
| | | | | | | | | Remove unused section (Generating rules) and simplify the code that reads basic rule definitions (name, type, family) in for example: <!-- #BLAZE_RULE (NAME = cc_binary, TYPE = BINARY, FAMILY = C / C++) --> -- MOS_MIGRATED_REVID=88200584
* The BE generator now warns if rules are undocumented.Gravatar Laszlo Csomor2015-03-05
| | | | | | | | It also caches files that it already processed, since that may legally happen if there are multiple overlapping directory trees are specified as input. -- MOS_MIGRATED_REVID=87492930
* Annotate the public/confidential/shared parts of the BE template.Gravatar Laszlo Csomor2015-02-26
| | | | | | | | | Rewrite some examples that used internal labels to be safe for external version. Also remove some obsolete parts such as no-longer existent Make variables. -- MOS_MIGRATED_REVID=87241538
* Update from Google.Gravatar Han-Wen Nienhuys2015-02-25
-- MOE_MIGRATED_REVID=85702957
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-29 17:06:02 +0000