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.

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

Escape generated markdown values. #11841

Merged
merged 2 commits into from
Apr 4, 2021
Merged

Escape generated markdown values. #11841

merged 2 commits into from
Apr 4, 2021

Conversation

benjyw
Copy link
Contributor

@benjyw benjyw commented Apr 2, 2021

This fixes various display bugs in our generated docs.

Also fixes a couple of issues with the doc generation script:

  • Disables the remote auth plugin when running Pants to
    get help, since we disable the Pants plugin that provides it.
  • Fix an issue with URLs for subscopes. The dot confuses
    the readme.com API, so we replace it with a dash.

[ci skip-rust]

[ci skip-build-wheels]

This fixes various display bugs in our generated docs.

Also fixes a couple of issues with the doc generation script:

- Disables the remote auth plugin when running Pants to
  get help, since we disable the Pants plugin that provides it.
- Fix an issue with URL generation for subscopes.

[ci skip-rust]

[ci skip-build-wheels]
@benjyw benjyw requested a review from Eric-Arellano April 2, 2021 21:36
@benjyw
Copy link
Contributor Author

benjyw commented Apr 2, 2021

Before:

Screen Shot 2021-04-02 at 2 36 54 PM

After:

Screen Shot 2021-04-02 at 2 37 08 PM

Copy link
Contributor

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much. This confused me a lot last time I looked at this.

Could you please cherry-pick so that we can regenerate docs for 2.2, 2.3, and 2.4?

# Rust tests and lints will be skipped. Delete if not intended.
[ci skip-rust]

# Building wheels and fs_util will be skipped. Delete if not intended.
[ci skip-build-wheels]
@benjyw benjyw merged commit 400cb26 into pantsbuild:main Apr 4, 2021
@benjyw benjyw deleted the fix_docgen branch April 4, 2021 04:03
benjyw added a commit to benjyw/pants that referenced this pull request Apr 5, 2021
This fixes various display bugs in our generated docs.

Also fixes a couple of issues with the doc generation script:

- Disables the remote auth plugin when running Pants to
  get help, since we disable the Pants plugin that provides it.
- Fix an issue with URL generation for subscopes.

[ci skip-rust]

[ci skip-build-wheels]
benjyw added a commit to benjyw/pants that referenced this pull request Apr 5, 2021
This fixes various display bugs in our generated docs.

Also fixes a couple of issues with the doc generation script:

- Disables the remote auth plugin when running Pants to
  get help, since we disable the Pants plugin that provides it.
- Fix an issue with URL generation for subscopes.

[ci skip-rust]

[ci skip-build-wheels]
benjyw added a commit that referenced this pull request Apr 6, 2021
This fixes various display bugs in our generated docs.

Also fixes a couple of issues with the doc generation script:

- Disables the remote auth plugin when running Pants to
  get help, since we disable the Pants plugin that provides it.
- Fix an issue with URL generation for subscopes.

[ci skip-rust]

[ci skip-build-wheels]
benjyw added a commit that referenced this pull request Apr 6, 2021
This fixes various display bugs in our generated docs.

Also fixes a couple of issues with the doc generation script:

- Disables the remote auth plugin when running Pants to
  get help, since we disable the Pants plugin that provides it.
- Fix an issue with URL generation for subscopes.

[ci skip-rust]

[ci skip-build-wheels]
@wisechengyi wisechengyi mentioned this pull request Apr 10, 2021
wisechengyi added a commit that referenced this pull request Apr 11, 2021
### Internal

* [internal] Setup toolchain auth for build-wheels jobs too. ([#11875](#11875))

* Disable remote cache in CI when building wheels and bootstrapping Pants ([#11874](#11874))

* Hotfix build wheels jobs failing due to new Shell backend ([#11855](#11855))

* Deflake tar extraction by setting the cwd through the engine ([#11867](#11867))

* [internal] Add timeouts on some pants runs that can take a long time. ([#11870](#11870))

* Switch to new Toolchain remote cache proxy ([#11820](#11820))

* Show debug level logs in dynamic UI ([#11873](#11873))

* Remove deprecated `MockConsole` ([#11871](#11871))

* Remove deprcated `PantsEnvironment` type ([#11823](#11823))

* Simplify `generate_github_workflow.py` ([#11866](#11866))

* [internal] Upgrade toolchain plugin to v0.8.1 ([#11861](#11861))

* Add macOS workaround to build wheels step ([#11864](#11864))

* Prepare 2.4.0rc2 ([#11865](#11865))

* Add `--remote-cache-warnings` and make remote cache warnings less chatty ([#11859](#11859))

* [internal] Upload pants logs and make them available as artifacts ([#11860](#11860))

* [internal] Load toolchain auth token in all GH events except PR ([#11853](#11853))

* Dogfood shfmt internally ([#11854](#11854))

* Prepare 2.4.0rc1 ([#11850](#11850))

* Prepare 1.30.5rc0. ([#11848](#11848))

* Rewrite Python linter tests to be more declarative ([#11828](#11828))

* Escape generated markdown values. ([#11841](#11841))

* Update tests away from deprecated MockConsole API ([#11834](#11834))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants