Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Host --output-format json files in addition to generated HTML #1285

Open
deeprobin opened this issue Feb 26, 2021 · 7 comments
Open

Host --output-format json files in addition to generated HTML #1285

deeprobin opened this issue Feb 26, 2021 · 7 comments
Labels
A-builds Area: Building the documentation for a crate C-enhancement Category: This is a new feature S-blocked Status: marked as blocked ❌ on something else such as an RFC or other implementation work.

Comments

@deeprobin
Copy link

I need this to implement my own "doc"-frontend for me into a multi-page-application.

@syphar
Copy link
Member

syphar commented Feb 26, 2021

@deeprobin what kind of information would you need?

docs.rs is just hosting some metadata and is serving the HTML files generated by rustdoc,

@deeprobin
Copy link
Author

Oh okay. Then it would be better if I open a issue in the rustdoc repository? I thought this was the right repository for this.

@Nemo157
Copy link
Member

Nemo157 commented Feb 26, 2021

Rustdoc has an in-progress JSON backend: rust-lang/rust#76578

There has been some very brief discussion of docs.rs generating and hosting these files along with the html. But at the moment I think it's quite buggy (e.g. rust-lang/rust#80664 is probably going to fail a large proportion of builds) and the format is unstable. I think it would make sense to wait a little longer till it has stabilized a bit more before we add it here (I know of at least a couple of users that are already building alternative renderers based on the json, which will hopefully drive it towards stabilization).

@jyn514 jyn514 changed the title Can docs.rs generate .json files? Host --output-format json files in addition to generated HTML Feb 26, 2021
@jyn514 jyn514 added A-builds Area: Building the documentation for a crate C-enhancement Category: This is a new feature S-blocked Status: marked as blocked ❌ on something else such as an RFC or other implementation work. labels Feb 26, 2021
@DottieDot
Copy link

Any progress/updates on this?

@syphar
Copy link
Member

syphar commented Jul 3, 2022

There are still open ICEs when generating the JSON (see this current discussion on zulip, rust-lang/rust#93518 is one of the fixes.

When this is solved I believe we have to partially finish #795 so we have the additional spare capacity for running the additional builds.

Of course on top of that the actual code change needs to be done.

@jyn514
Copy link
Member

jyn514 commented Jul 3, 2022

I don't think we should start hosting this until the JSON backend is stabilized. The output format is likely to change several more times before stabilization.

@syphar
Copy link
Member

syphar commented Jul 3, 2022

yeah, also valid point, I only had in mind that we could find more ICEs when running it for docs, but the format changing could be annoying for users of the JSON

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-builds Area: Building the documentation for a crate C-enhancement Category: This is a new feature S-blocked Status: marked as blocked ❌ on something else such as an RFC or other implementation work.
Projects
None yet
Development

No branches or pull requests

5 participants