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

[website] Generate links to ScalaDoc for API page #3661

Merged
merged 1 commit into from Nov 30, 2023

Conversation

jackkoenig
Copy link
Contributor

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Documentation or website-related

Desired Merge Strategy

  • Squash

Release Notes

The website will now actual reflect the latest snapshot and releases on the API page

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.5.x, 3.6.x, or 5.x depending on impact, API modification or big change: 6.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@jackkoenig jackkoenig added the Documentation Only changing documentation label Nov 30, 2023
Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

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

Skimmed the code for versions, contributors, and releases. This all seems fine.

I didn't grok the magic in the import bit of the api.md. However, importing markdown from some other area makes this very cool.

* [3.6](https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.6.0)
* [3.5](https://javadoc.io/doc/edu.berkeley.cs/chisel3_2.13/3.5.6)

<ScalaDoc />
Copy link
Member

Choose a reason for hiding this comment

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

Can you comment on how this works? The import is a special thing that gets evaluated by mdx and the <ScalaDoc /> actually includes it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah exactly, it's documented in the Docusaurus docs: https://docusaurus.io/docs/markdown-features/react#importing-markdown

And in the MDX docs: https://mdxjs.com/docs/using-mdx/#components

@jackkoenig jackkoenig merged commit 3aa1e4c into main Nov 30, 2023
15 checks passed
@jackkoenig jackkoenig deleted the website-generate-api-links branch November 30, 2023 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Only changing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants