Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include the module's docstring in the header #100

Merged
merged 5 commits into from
Oct 4, 2021
Merged

Include the module's docstring in the header #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
586650b
Include the module's docstring in the header
alexeagle Apr 27, 2021
6467aba
replace custom diff test with skylib one
alexeagle Oct 1, 2021
e831911
Update golden files
alexeagle Oct 1, 2021
900f9f0
update skylib to 1.1.1
alexeagle Oct 4, 2021
1c7374c
Revert diff_test
alexeagle Oct 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/stardoc_rule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

Starlark rule for stardoc: a documentation generator tool written in Java.

<a id="#stardoc"></a>

## stardoc
Expand Down
2 changes: 2 additions & 0 deletions stardoc/templates/html_tables/header.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

${moduleDocstring}
2 changes: 2 additions & 0 deletions stardoc/templates/markdown_tables/header.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

${moduleDocstring}
2 changes: 2 additions & 0 deletions test/testdata/android_basic_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#android_related_rule"></a>

## android_related_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/angle_bracket_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

Input file to test angle bracket bug (https://github.com/bazelbuild/skydoc/issues/186)

<a id="#my_anglebrac"></a>

## my_anglebrac
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/apple_basic_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#apple_related_rule"></a>

## apple_related_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/aspect_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

The input file for the aspect test

<a id="#my_aspect_impl"></a>

## my_aspect_impl
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/attribute_defaults_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

A golden test to verify attribute default values.

<a id="#my_rule"></a>

## my_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/attribute_types_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#my_rule"></a>

## my_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/cc_api_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

Input file for C++ api test

<a id="#cpp_related_rule"></a>

## cpp_related_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/config_apis_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#int_setting"></a>

## int_setting
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/cpp_basic_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#cpp_related_rule"></a>

## cpp_related_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/filter_rules_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#my_rule"></a>

## my_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/function_basic_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

A test that verifies basic user function documentation.

<a id="#check_sources"></a>

## check_sources
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/generated_bzl_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

A direct dependency file of the input file.

<a id="#my_rule"></a>

## my_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/html_tables_template_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

Input file for markdown template test

<a id="#example_rule"></a>

## example_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/java_basic_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#java_related_rule"></a>

## java_related_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/local_repository_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

A test that verifies documenting functions in an input file under a local_repository.

<a id="#min"></a>

## min
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/macro_kwargs_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

Tests for functions which use *args or **kwargs

<a id="#macro_with_args"></a>

## macro_with_args
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/misc_apis_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#my_rule"></a>

## my_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/multi_level_namespace_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

A test that verifies documenting a multi-leveled namespace of functions.

<a id="#my_namespace.min"></a>

## my_namespace.min
Expand Down
4 changes: 4 additions & 0 deletions test/testdata/multi_level_namespace_test_with_whitelist/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

A test that verifies documenting a multi-leveled namespace of functions with whitelist symbols.
The whitelist symbols should cause everything in my_namespace to to be documented, but only a
specific symbol in other_namespace to be documented.

<a id="#my_namespace.min"></a>

## my_namespace.min
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/multiple_files_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

A direct dependency file of the input file.

<a id="#my_rule"></a>

## my_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/multiple_rules_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#my_rule"></a>

## my_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/namespace_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

A test that verifies documenting a namespace of functions.

<a id="#my_namespace.assert_non_empty"></a>

## my_namespace.assert_non_empty
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/provider_basic_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#MyFooInfo"></a>

## MyFooInfo
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/providers_for_attributes_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

The input file for the providers for attributes test

<a id="#my_rule"></a>

## my_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/py_rule_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

The input file for the python rule test

<a id="#py_related_rule"></a>

## py_related_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/repo_rules_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#my_repo"></a>

## my_repo
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/same_level_file_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#my_rule"></a>

## my_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/simple_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#my_rule"></a>

## my_rule
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/struct_default_value_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

The input file for struct default values test

<a id="#check_struct_default_values"></a>

## check_struct_default_values
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/unknown_name_test/golden.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->



<a id="#my_rule_impl"></a>

## my_rule_impl
Expand Down