API Docs generator for UE-projects - Surreal Docs!

[meager violet]

It generates C++ API reference, Blueprint API reference, embeds user-provided Markdown pages and also seamlessly integrates with our online docs hosting - Surreal Cloud. Available for free*.

• Download Surreal Docs from our GitHub at https://github.com/medelfor/surreal-docs
• Take a look at live-demo of a sample documentation generated with Surreal Docs and hosted by Surreal Docs Cloud is available at https://surrealdocs.com/
• Explore Surreal Docs documentation at https://docs.medelfor.com/medelfor/surreal-docs
• Buy an enhanced Surreal Docs license from our store at https://store.medelfor.com
• Check out more Medelfor products on our website: https://medelfor.com

*for individuals and small companies

[meager violet]

The feature of the week: Versioning!

A convenient feature Surreal Docs Cloud provides is the ability to save as many versions of your documentation as you'd like, what's extremely useful e.g. when you want to have a separate documentation version for each version of your project.

Surreal Docs Cloud offers your documentation readers an easy way to switch between the versions through a selector at the top of every page. In case when currently selected version is not the latest one, Surreal Docs Cloud will warn reader about possibly outdated documentation.

Live-demo of a documentation generated by Surreal Docs and hosted by Surreal Docs Cloud can be found at https://surrealdocs.com/medelfor/showcase-1/1.1.0/en-US/

If you're interested in Surreal Docs add yourself to our waitlist at https://medelfor.com

This post is a part of weekly series that demonstrates capabilities of Surreal Docs and Surreal Docs Cloud.

#UnrealEngine5

[meager violet]

The feature of the week: Smart Documentation!

Surreal Docs includes a lot of smart features and one of them is full understanding of UE-specific C++ features, e.g. method suffixes such as _Implementation and _Validate. Surreal Docs not only will merge docs pages for base method and its _Implementation version but also will provide a link to _Validate-method, in case reader is interested.

Live-demo of a documentation generated by Surreal Docs and hosted by Surreal Docs Cloud can be found at https://surrealdocs.com/medelfor/showcase-1/1.1.0/en-US/api/cpp/Jetpack/AJetpack/BlowItUp

If you're interested in Surreal Docs add yourself to our waitlist at https://medelfor.com

This post is a part of weekly series that demonstrates capabilities of Surreal Docs and Surreal Docs Cloud.

#UnrealEngine5

[meager violet]

The feature of the week: Blueprint API Reference!

One of the most important abilities of Surreal Docs is the ability to generate Blueprint API Reference that includes all functions, variables, classes, enumerations, structures and interfaces from your project, grouped by modules. The reference covers not only entities defined directly via the Editor but the ones that are defined in C++ and exposed to Blueprints as well.

Live-demo of a Blueprint API reference generated by Surreal Docs can be found at https://surrealdocs.com/medelfor/showcase-1/1.1.0/en-US/api/blueprint

If you're interested in Surreal Docs add yourself to our waitlist at https://medelfor.com

This post starts a weekly series that demonstrates capabilities of Surreal Docs and Surreal Docs Cloud.

#UnrealEngine5

[hoary kayak]

Can this work for plugins as well? I can't understand how to use it?

[meager violet]

Hi @hoary kayak, thank you for your interest! Yes, absolutely, it can work with plugins as well. The product isn't available right now, since we're targeting late spring for release of public preview. Meanwhile you can add yourself to our waitlist at https://medelfor.com to get news about upcoming release first!

[meager violet]

The feature of the week: Adaptive design!

Surreal Docs generates docs pages that aren't just pretty but also 100% suitable for any screen size be it a desktop PC, a tablet or a smartphone. Just write the documentation and let Surreal Docs make sure it looks great!

You can check out live-demo of a documentation generated by Surreal Docs and hosted by Surreal Docs Cloud at https://surrealdocs.com/medelfor/showcase-1/1.1.0/en-US/

If you're interested in Surreal Docs don't forget to join our waitlist at https://medelfor.com

Follow us on Twitter: https://twitter.com/medelfor

This post is a part of weekly series that demonstrates capabilities of Surreal Docs and Surreal Docs Cloud.

#UnrealEngine5

[meager violet]

We've got two good news for you!

First, Surreal Docs' logo isn't ugly anymore. Isn't that great?!
Second, Surreal Docs is going public preview one week from now - May 31, yay!

Stay tuned and get ready your UE-projects, because they're finally going to get that documentation!

More info at https://medelfor.com

[meager violet]

Surreal Docs is out!

Download Surreal Docs from out GitHub at https://github.com/medelfor/surreal-docs
Explore the documentation at https://docs.medelfor.com/medelfor/surreal-docs
Buy an enhanced Surreal Docs license from our store at https://store.medelfor.com
Check out more Medelfor products on our website: https://medelfor.com

[meager violet]

Hi @hoary kayak! Since Surreal Docs is out now and you asked about generating docs for plugins, here's a relevant page from our documentation: https://docs.medelfor.com/medelfor/surreal-docs/1.0.1/en-US/docs/generate-docs-for-plugins

[meager violet]

[Released] We develop a docs generator for Unreal Engine-projects - Surreal Docs!

[meager violet]

Surreal Docs 1.0.2 is out now!

What's new:

• Fixes of numerous bugs;
• Support of UE 5.2;
• Ability to send the logs to Medelfor right out of the CLI in case something goes wrong.

https://github.com/medelfor/surreal-docs/releases/tag/1.0.2

[meager violet]

Surreal Docs 1.0.4 is out!

What's new:

• Support of content-only plugins
• Improved log reporting system
• Fixes of a few bugs

https://github.com/medelfor/surreal-docs/releases/tag/1.0.4

[ember shell]

Great idea! Joining the github!

[meager violet]

Thank you!

[meager violet]

Surreal Docs 1.1.0 is out!

What's new:

• Full integration of Surreal Cloud https://docs.medelfor.com/medelfor/surreal-docs/latest/en-US/docs/surreal-cloud (incl. Surreal Cloud+):
• generate can now be used to easily deploy documentation to Surreal Cloud;
• Management of organizations;
• Management of projects and their visibility;
• Management of access tokens;
• Management of user's quota;
• Management of project collaborators.
• Greatly reduced prices, check out our Store at https://store.medelfor.com;
• No NodeJS dependency anymore;
• migrate command which migrates the surreal project to a new version;
• No .uproject file changes happen now;
• Fixed issue with management of modules in surdocs init;
• Fixed SEGFAULT because of invalid references;
• Fixed wrong "Last updated" info;
• Fixed export of classes derived from UDeveloperSettings, USubsystem, UBlueprintFunctionLibrary;
• Installation of Surreal Docs is now system-wide, while logs and cache are separate for each user;
• Abstract classes are properly exported now;
• Interfaces and their functions are properly matched with their counterparts now;
• Everything overridable is exported in Blueprint Reference now;
• Other minor improvements.

Surreal Docs on GitHub: https://github.com/medelfor/surreal-docs

You can download Surreal Docs installer from our website https://medelfor.com.

Detailed changelist can be found at https://docs.medelfor.com/medelfor/surreal-docs/latest/en-US/docs/changelog.

[meager violet]

Docs generator for Unreal Engine-projects - Surreal Docs!

[meager violet]

Surreal Docs 1.1.1 is out!

What's new:

• Pay-once-use-forever pricing option (check out the pricing page at https://medelfor.com/products/surreal-docs#pricing);
• No Surreal Cloud subscription is now required to remove the watermarks;
• register command, use to activate your copy of the product;
• Ability to customize company logo;
• Up to 100% speed up of image rendering (controlled with --image-threads);
• Properties and functions internally created by UE for timelines are ignored now, not allowing the documentation to be contaminated with "garbage" and speeding up the generation process;
• Functions internally created by UE for latent functions are ignored as well;
• Component event bindings now have a readable as-in-editor title;
• Fix of erroneous crop of "Authority only" and "Cosmetic" functions;
• Fix of incorrectly processed internal links on Markdown pages;
• Absolute paths in surreal.json are no more;
• Fix of the plugin's type;
• Other minor improvements.

Check out the detailed changelist at https://docs.medelfor.com/medelfor/surreal-docs/1.1.1/en-US/docs/changelog;

Useful links:

• You can download Surreal Docs from our website: https://medelfor.com/products/surreal-docs#download;
• Check out our documentation hosting built specifically for Surreal Docs: Surreal Cloud https://medelfor.com/products/surreal-cloud
• Take a glimpse at what we're preparing for the next release in our roadmap: https://medelfor.com/roadmap/surreal-docs;
• Check out our GitHub for more technical info: https://github.com/medelfor/surreal-docs
• Explore Surreal Docs documentation at https://docs.medelfor.com/medelfor/surreal-docs
• Buy an enhanced Surreal Docs license from our store at https://store.medelfor.com
• Check out more Medelfor products on our website: https://medelfor.com
• Take a look at live-demo of a sample documentation generated with Surreal Docs and hosted by Surreal Docs Cloud at https://surrealdocs.com/

[meager violet]

[Released] Docs generator for Unreal Engine-projects - Surreal Docs!

[meager violet]

[Released] Docs generator for UE-projects - Surreal Docs!