Closed CAD97 closed 6 years ago
Thanks, @CAD97, for the diff!
This TODO item was left over from an old project, IIRC. With https://docs.rs/unic/ hosting the docs for the latest release, do you think it still worth setting up a CI-based doc publication for master?
Also, last time I checked (in the summer), the cargo-travis
package was not maintained actively anymore and didn't work in some cases that I needed. Do you think it's going to be reasonably stable to enable it here?
And something else related here is that we have other kinds of docs besides API docs, currently put under https://github.com/behnam/rust-unic/tree/master/docs.
My vision is to have more of these kinds of docs, as many Unicode & i18n issues are not just API docs, but architecture and which APIs need to be used for what application.
So, I was hoping that, whenever we set a homepage-kind-of-thing up for UNIC, it will cover both of these docs.
If we want to do this, then we need to compose the root README.md
, with the docs/
dir and target/doc/
into on structure, and put that into gh-pages
.
What do you think?
Ah right. I forgot about those docs.
Note that travis-cargo (the python script) is different from cargo-travis, to which I merged a couple PRs to enable doc-upload and a couple other things.
If we're already serving docs from the /docs
folder, then we're good as is (feel free to close this). master
docs are useful for some crates, whereas docs.rs only serves the published versions. It also would be slightly more useful potentially given that all of the crates would be available in one flat hierarchy and selectable on the left menu.
If we want have the API docs built and the guide-like docs from /docs
built to gh-pages, I can spin something together next weekend probably. The files that doc-upload touches are specified clearly in order to enable something like this.
Closing for now. I'll investigate building guide- and reference- docs in the future, especially now that I've broken out cargo-ghp-upload
which I know should work properly now.
@behnam you'll need to add a
$GH_TOKEN
to Travis for this to work.