Skip to content
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

Documentation is not available #644

Closed
aleksmelnikov opened this issue Oct 11, 2018 · 7 comments
Closed

Documentation is not available #644

aleksmelnikov opened this issue Oct 11, 2018 · 7 comments

Comments

@aleksmelnikov
Copy link

Documentation for embedding is not available

https://docs.rs/gluon/*/gluon/fn.new_vm.html
The requested resource does not exist

Need your help, please.

@Marwes
Copy link
Member

Marwes commented Oct 11, 2018

Yeah, this is an issue of docs.rs not being updated. I have thought about uploading docs to gluon-lang.org instead but I don't really want to update all links to it only to then change them back once docs.rs is updated (I rather have the docs there since it allows one to looks at older versions etc).

For the moment the easiest way would be to do git clone https://github.com/gluon-lang/gluon && cd gluon && cargo doc --open to get the docs locally at least. I may try and host them anyway on gluon-lang.org though, just not as the canonical docs.

@Marwes
Copy link
Member

Marwes commented Oct 11, 2018

@Marwes
Copy link
Member

Marwes commented Oct 12, 2018

Actually, I could maybe use feature flags to disable the features that require rust 1.29 just for docs.rs and make it produce docs even if gluon itself requires 1.29. Making a 0.9.3 release sometime this weekend after I have gotten https working for gluon-lang.org so I could include this then.

https://docs.rs/crate/gluon/0.9.2/builds/120287

@Marwes
Copy link
Member

Marwes commented Oct 20, 2018

Seems like things are happening on the docs.rs end and the docs for gluon 0.9.4 can at least for the moment be found at http://docsrs.csail.mit.edu/gluon/0.9.4/gluon/.

I also host docs on https://gluon-lang.org/rust_doc/gluon/index.html now (linked from the root page) but I will probably link to docs.rs once that gets sorted out and only have those docs as a mirror.

https://github.com/onur/docs.rs/issues/233
https://github.com/onur/docs.rs/pull/243

@aleksmelnikov
Copy link
Author

Glad to see your information. Thank you.

@QuietMisdreavus
Copy link

The linked PR on docs.rs has been merged and the docs for gluon have been rebuilt: https://docs.rs/gluon/0.9.4/gluon/

@Marwes
Copy link
Member

Marwes commented Oct 25, 2018

🎉 Awesome! Thanks for getting docs.rs updated!

@Marwes Marwes closed this as completed Oct 25, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants