Skip to content

Parse Godot documentation's BBCode and translate it to RustDoc #779

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

Merged
merged 9 commits into from
Sep 2, 2021

Conversation

Bromeon
Copy link
Member

@Bromeon Bromeon commented Sep 1, 2021

Closes #590.

Parse Godot documentation's BBCode and translate it to RustDoc, so that our API doc looks nicer. In particular, many intra-doc links are now recognized. As a result, it's now much easier to navigate through the GDNative bindings' doc.

The parser is not perfect, there are also some missing parts, but it should already be a big improvement over weird BBCode syntax.

bors try

Handles the following:
* [url=U]text[/url]
* [url=U][/url]
* [member M]
* [member C.M]
* [method M]
* [method C.M]
* [constant M]
* [constant C.M]
* [enum C]
@Bromeon Bromeon added c: bindings Component: GDNative bindings (mod api) documentation labels Sep 1, 2021
bors bot added a commit that referenced this pull request Sep 1, 2021
@Bromeon Bromeon added this to the v0.10 milestone Sep 1, 2021
@bors
Copy link
Contributor

bors bot commented Sep 1, 2021

try

Build succeeded:

@Bromeon Bromeon force-pushed the 590/bbcode-to-rustdoc branch from fdc9c32 to a2a3c51 Compare September 2, 2021 14:20
@Bromeon
Copy link
Member Author

Bromeon commented Sep 2, 2021

bors r+

@bors
Copy link
Contributor

bors bot commented Sep 2, 2021

Build succeeded:

@bors bors bot merged commit b6dcf6e into godot-rust:master Sep 2, 2021
@Bromeon Bromeon deleted the 590/bbcode-to-rustdoc branch September 2, 2021 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: bindings Component: GDNative bindings (mod api) documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Parse and convert custom BBCode in doc XMLs to Markdown
1 participant