-
Notifications
You must be signed in to change notification settings - Fork 50
Comparing changes
Open a pull request
base repository: bazelbuild/stardoc
base: 0.5.6
head repository: bazelbuild/stardoc
compare: 0.6.0
- 11 commits
- 99 files changed
- 3 contributors
Commits on Jul 13, 2023
-
Move the markdown renderer from Bazel repo into Stardoc repo (#162)
Moving from https://github.com/bazelbuild/bazel/tree/3d2604806a9747f317c5b560bbf89cdc1be033ba * src/main/java/com/google/devtools/build/skydoc/renderer/RendererOptions.java and src/main/java/com/google/devtools/build/skydoc/renderer/RendererMain.java have been changed to use JCommander instead of Bazel's options library for command-line arg parsing. All other .java files have been copied from Bazel without any changes and without any file/directory renames. * integration tests from src/test/java/com/google/devtools/build/skydoc/testdata in Bazel have been merged into tests/testdata in Stardoc where appropriate (filter_rules_test, function_basic_test, function_wrap_multiple_lines_test, multi_level_namespace_test_with_allowlist, provider_basic_test, pure_markdown_template_test, repo_rules_test) * updated Stardoc's deps and to allow building the renderer. In particular, we now are forced to depend on rules_jvm_external unconditionally, even in releases. * removed renderer_binary.jar
Configuration menu - View commit details
-
Copy full SHA for dbe0107 - Browse repository at this point
Copy the full SHA dbe0107View commit details -
Fix linter errors and switch from Apache Velocity to Google Escapevel…
…ocity for templating (#163) Internal tooling complains about any new Velocity usage
Configuration menu - View commit details
-
Copy full SHA for 8e04b9b - Browse repository at this point
Copy the full SHA 8e04b9bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1527ba0 - Browse repository at this point
Copy the full SHA 1527ba0View commit details
Commits on Jul 18, 2023
-
Do not HTML-escape and use Markdown inline code for defaults (#161)
Reverts #133 so that HTML escaping is not applied to Markdown. Instead, Markdown content such as docstrings can use HTML formatting and escape angle brackets with backslashes, HTML entities or inline code segments. Default values are embedded in inline code segments instead of `<code>` tags, which does not require escaping. As a result, docstrings behave just like regular Markdown contexts while default values are rendered without smart quotes and can contain both `<` and `` ` `` without causing escaping issues. Also includes tests based on #138. Fixes #137 Closes #138 Fixes #142 Closes #143 Requires bazelbuild/bazel#18867 Co-authored-by: Adam Azarchs <adam.azarchs@10xgenomics.com>
Configuration menu - View commit details
-
Copy full SHA for 6b6acb3 - Browse repository at this point
Copy the full SHA 6b6acb3View commit details
Commits on Jul 25, 2023
-
Use native starlark_doc_extract rule for doc extraction if it is avai…
…lable * When available (i.e. in Bazel 7, or in current development Bazel at HEAD), try use the `starlark_doc_extract` native rule for doc extraction instead of the legacy pre-built extraction jar. This behavior can be disabled by passing `use_starlark_doc_extract = False` to the `stardoc` macro. * Add templates and markdown rendering functionality for repository rule and module extension info protos (which are output by `starlark_doc_extract`). * Temporary wart: for module extensions, by default we would want the summary blurb to look something like ``` my_ext = use_extension("@my_local_repo//some:file.bzl", "my_ext") my_ext.tag(foo, bar) ``` but alas, we don't have a good way to get the name of the local repo from Starlark when bzlmod is enabled. * ... and of course, update tests. Which means in some cases, we have to fork the golden files into current (i.e. `starlark_doc_extract`-enabled) and legacy flavors. Fixes #69 Fixes #76 Fixes #81 Fixes #123Configuration menu - View commit details
-
Copy full SHA for f8fab82 - Browse repository at this point
Copy the full SHA f8fab82View commit details
Commits on Aug 1, 2023
-
Configuration menu - View commit details
-
Copy full SHA for b124535 - Browse repository at this point
Copy the full SHA b124535View commit details -
In Markdown table cells, apply HTML escaping only to code blocks, and…
… apply it properly (#167) In Markdown table cells, apply HTML escaping only to code blocks, and apply it properly Since #161 removed HTML escaping for defaults and function docstrings, we should do the same for attribute and param docs in table cells. The only limitations Markdown places on table cells are: * no pipe characters (they must be escaped with a backslash) * no newlines (they must be transformed into `<br>` or an HTML entity) The latter restriction makes it impossible to have a fenced code block inside a table cell. Therefore: * we do not escape HTML or Markdown markup outside a fenced code block * we keep existing logic for escaping newlines outside a fenced code block * we fix fence detection (e.g. allowing more than 3 fence characters to support embedded code blocks in code blocks, allowing tildes as fence characters, properly handling language names, etc.); * in code block content, we escape HTML, and we escape newlines as HTML entities (since `<br>` does not work in a `<pre><code>` block) - finally fixing code block newlines in table cells. This is a followup to #161. Partially addresses #118
Configuration menu - View commit details
-
Copy full SHA for 4736754 - Browse repository at this point
Copy the full SHA 4736754View commit details
Commits on Aug 2, 2023
-
Enable render_main_repo_name by default with starlark_doc_extract (#168)
Most Stardoc users are probably documenting their rules for users from other repos - so we ought to render labels in the repo being documented with the repo name.
Configuration menu - View commit details
-
Copy full SHA for 056ba3b - Browse repository at this point
Copy the full SHA 056ba3bView commit details -
Bump bazel dep and add docstring dedenting test cases (#170)
We want bazelbuild/bazel@b71b2df in order to dedent and trim doc strings from all sources (not just functions, but also rules, providers, attributes, etc.).
Configuration menu - View commit details
-
Copy full SHA for b8856b4 - Browse repository at this point
Copy the full SHA b8856b4View commit details
Commits on Aug 3, 2023
-
Fix non-bzlmod distribution (#172)
Since we are building the renderer from source and using rules_jvm_external to pull in Maven deps, the WORKSPACE setup for a user of Stardoc is now significantly more complicated; the user will now need to do the multi-step rules_jvm_external initialization and maven_install. For convenience, let's wrap maven_install in a macro - and finally split out the legacy-test-only maven deps into their own .json file and repo. Update stardoc_repositories to pull in all the new deps we need to build Java code. Update maintainer guide.
Configuration menu - View commit details
-
Copy full SHA for af19cfe - Browse repository at this point
Copy the full SHA af19cfeView commit details -
Configuration menu - View commit details
-
Copy full SHA for 00b171f - Browse repository at this point
Copy the full SHA 00b171fView commit details
This comparison is taking too long to generate.
Unfortunately it looks like we can’t render this comparison for you right now. It might be too big, or there might be something weird with your repository.
You can try running this command locally to see the comparison on your machine:
git diff 0.5.6...0.6.0