Misc #20639
open
Request to host C API docs on docs.ruby-lang.org
Description
Having a first-party documentation site benefits readers and helps
contributors improve the contents. The Ruby standard library API benefits from
being hosted on https://docs.ruby-lang.org and it would be nice if the C API
documentation produced by Doxygen can be hosted on the same site as well.
I'm not familiar with the logistics of hosting the documentation site, and traffic
is not free. But I think this is worth considering for the benefit of Ruby
extension authors and maintainers.
At the moment, https://github.com/ruby/actions generates the documentation with
Doxygen but it's not hosted anywhere as far as I can tell. Searching for
"Ruby C API documentation" on Google lead to guides about the API and no results
that provide a comprehensive up-to-date reference.
Updated by znz (Kazuhiro NISHIYAMA) about 22 hours ago
They hosted on S3 directly (URLs can be deduced from the workflow file), but they are not for public now.
I agree to serve them on docs.ruby-lang.org.
We want to consider their URL before serving.
Current paths are:
-
/en/VERSION/for rdoc -
/ja/VERSION/for rurema -
/ja/search/for rurema-search
What path is good for documents generated by Doxygen?
Updated by alanwu (Alan Wu) about 8 hours ago
I think /capi/en/VERSION is a good starting point.