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

Better documentation creation ref #648 #677

Merged
merged 9 commits into from
Mar 13, 2024
Merged

Conversation

Roba1993
Copy link
Contributor

Hey,

I implemented the enhancements for the documentation generation #648 by myself.
Looking forward to get these improvements merged 😄

Right now I called the link back to the root overview just 'Overview', maybe you have a better name.

Please let me know if something if not as you like.
Thanks,
Robert

@udoprog udoprog added the enhancement New feature or request label Mar 13, 2024
@udoprog
Copy link
Collaborator

udoprog commented Mar 13, 2024

Looks very nice!

@@ -1,5 +1,5 @@
{{#> layout}}
<h3 class="title">Enum {{literal module}}::<span class="enum">{{name}}</span></h3>
<div class="title-wrapper"><h3 class="title">Enum {{literal module}}::<span class="enum">{{name}}</span></h3><a class="overview" href="{{literal root_index}}">Overview</a></div>
Copy link
Collaborator

@udoprog udoprog Mar 13, 2024

Choose a reason for hiding this comment

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

Could you post a screenshot of how the overview links is expected to render with title-wrapper?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Bildschirmfoto 2024-03-13 um 17 12 19 It look like this right now. I really tried to find a better place, but failed 😅 But the original rust documentation is also using that place, but for another feature.....

@Roba1993
Copy link
Contributor Author

Closes #648 when merged

@udoprog udoprog merged commit 08d59bd into rune-rs:main Mar 13, 2024
19 checks passed
@udoprog
Copy link
Collaborator

udoprog commented Mar 13, 2024

Thanks for putting this together!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants