DocFX
docs.rs
DocFX | docs.rs | |
---|---|---|
18 | 139 | |
3,889 | 947 | |
0.9% | 0.7% | |
9.8 | 9.5 | |
3 days ago | 3 days ago | |
C# | Rust | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
DocFX
-
TSDocs.dev: type docs for any JavaScript library
This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool?
https://docs.oracle.com/javase/8/docs/technotes/tools/window...
https://dotnet.github.io/docfx/
I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated by the above tools to discover new API's that suit my needs, diving into the actual code using a good decompiler is still my first move, as it is often cheaper than seeking out the documentation online, and it will show me the actual implementation as well. So in my opinion there is no shame in looking inside the declaration files!
-
Use Case Driven Development with Low-Code
Tools like DocFx provide the ability to display the programmable functions in HTML pages. They are used with the following commands in the docfx folder:
-
Anybody know if there's a library for the doc engine that MS Docs/Learn uses?
AFAIK they use https://github.com/dotnet/docfx which can be too heavy for your case. We use mdBook for internal documentation (plain .md with mermaid plugin) and then serve it at docs.yourdevenv.com.
- Is there a simple way to auto-generate a wiki / documentation for project code that pulls from comments or <summary> tags?
-
What the latest tool to generate website docs from /// summary comments?
DocFX is a nice solution.
-
How to build a solution like docs.microsoft.com
It uses DocFX
-
Comments in Javascript
Some of the standard and well-maintained Tools for Comments are JSDoc for Javascript, DocFx for .NET, and JavaDoc for Java.
-
What Does Microsoft Use to Create their KB Articles?
Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/
-
Library / Codebase Documentation - Multiple aggregated libraries - How to create? DocFx does not support this?
We would really prefer to use a somewhat generic pre-made tool for this (such as DocFX) compared to rolling our own solution. We can roll our own solution... But would prefer not to so that we can minimize development and maintenance overhead.
docs.rs
-
Using GenAI to improve developer experience on AWS
Working in combination with CodeWhisperer in your IDE, you can send whole code sections to Amazon Q and ask for an explanation of what the selected code does. To show how this works, we open up the file.rs file cloned from this GitHub repository. This is part of an open source project to host documentation of crates for the Rust Programming Language, which is a language we are not familiar with.
-
TSDocs.dev: type docs for any JavaScript library
Looks like a great initiative – I wish there was a reliable TS/JS equivalent of https://docs.rs (even considering rustdoc's deficiencies[1]).
I went through this exercise recently and so far my experience with trying to produce documentation from a somewhat convoluted TS codebase[2] has been disappointing. I would claim it's a consequence of the library's public (user-facing) API substantially differing from how the actual implementation is structured.
Typedoc produces bad results for that codebase so sphinx-js, which I wanted to use, doesn't have much to work with. I ultimately documented things by hand, for now, the way the API is meant to be used by the user.
Compare:
https://ts-results-es.readthedocs.io/en/latest/reference/api...
vs
https://tsdocs.dev/docs/ts-results-es/4.1.0-alpha.1/index.ht...
-
How did I need to know about feature rwh_05 for winit?
Rust Search Extension adds a section on docs.rs menubar which lists the features of a crate in a nice and easy to access format.
-
Embassy on ESP: GPIO
📝 Note: At the time of writing this post, I couldn't really locate the init function docs.rs documentation. It didn't seem easily accessible through any of the current HAL implementation documentation. Nevertheless, I reached the signature of the function through the source here.
-
First Rust Package - Telegram Notification Framework (Feedback Appreciated)
Rust Crates are a Game-Changer 🎮:The ease of releasing a crate with `cargo publish` and the convenience of rolling out new versions amazed me. The auto-generated docs on Docs.rs. is an amazing tool, especially with docstring formatting. Doc tests serve as a two-fold tool for documenting the code and ensuring it's up-to-date.
-
Grimoire: Open-Source bookmark manager with extra features
I've found I manually type out certain subsets of URLs where possible[0], maybe that's subconsciously associated with my impression that Google Search results have gotten worse and worse over the years.
[0] https://en.wiktionary.org/wiki/ and https://docs.rs/ come to mind.
-
Released my first crate ~20 hours ago; already downloaded 12 times. Who would know about it?
docs.rs also downloads you crate automatically to generate docs and I would guess lib.rs does something similar
- Docs.rs Is Down
-
Managed to land a junior role need help!
There are also a few key sites you'll want to keep in your back pocket at all times: - The Standard Library Documentation has complete documentation for every std library function in Rust - crates.io is a repository for all third-party packages, and docs.rs has human-readable documentation for the overwhelming majority of them - The Rust Cookbook has some code examples for common tasks you may need to perform - Make sure you are using clippy, which is available through Rustup and can be run with cargo clippy as a replacement to cargo check, it adds additional lints for your Rust code and is very helpful for teaching many of the best practices
-
How do you like code documentation inline in the source code vs. as separate guides, or how would you do it?
OTOH, source-code-generated-docs normalize how code docs are, like the rust docs.rs paradigm, so it sort of forces or encourages package creators/maintainers to write docs.
What are some alternatives?
Sandcastle - Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.
crates.io - The Rust package registry
MkDocs - Project documentation with Markdown.
serenity - A Rust library for the Discord API.
Swashbuckle - Seamlessly adds a swagger to WebApi projects!
tui-input - TUI input library supporting multiple backends, tui-rs and ratatui
DocNet - Your friendly static documentation generator, using markdown files to build the content.
config-rs - ⚙️ Layered configuration system for Rust applications (with strong support for 12-factor applications).
SharpDox
bevy - A refreshingly simple data-driven game engine built in Rust
F# Formatting - F# tools for generating documentation (Markdown processor and F# code formatter)
awesome-bevy - A collection of Bevy assets, plugins, learning resources, and apps made by the community