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

doc,rustdoc: improvements #9868

Closed
wants to merge 6 commits into from
Closed

Conversation

adrientetar
Copy link
Contributor

  • switch pandoc to HTML5, add tutorial PDF gen.
  • cleanup and refactor CSS, expand tutorial/manual CSS +some Bootstrap elements, cleanup unused doc/lib.css

you can see it here in action: http://adrientetar.legtux.org/cached/rust-doc/rust.html

  • minor rustdoc cleanups

@alexcrichton

@alexcrichton
Copy link
Member

Would you mind also uploading a preview of the tutorial and the new std/extra documentation? Thanks for this work!

@adrientetar
Copy link
Contributor Author

  1. (As said in the log) browsers automatically fetch favicon.ico from the root of the domain so this is unnecessary (unless you want to hardcode or force a specific favicon name), pretty much all browsers since IE 6 and (iirc) IE 5.5 support it, see here: http://en.wikipedia.org/wiki/Favicon#How_to_use
  2. tutorial: http://adrientetar.legtux.org/cached/rust-doc/rust.html
    std/extra doc: http://adrientetar.legtux.org/cached/rust-doc/index.html

@thestinger
Copy link
Contributor

You might want to use a different favicon for the documentation than the root of the site.

@adrientetar
Copy link
Contributor Author

@thestinger Hmm, not sure what else than the Rust logo we'd want to use, plus the doc itself is part of the Rust website, so...

@thestinger
Copy link
Contributor

rustdoc isn't just for generating the Rust site's documentation though.

@adrientetar
Copy link
Contributor Author

@thestinger Right, I was focused on the website.

@adrientetar
Copy link
Contributor Author

Okay, log updated. 🍒

@adrientetar
Copy link
Contributor Author

@cmr I didn't understand the point of the rust class, think it's an old dinosaur: this code spot is the only one in the manual that has this class and in the old CSS it made the code square to have light blue background instead of grey (which I didn't understand why...?) so I dropped it from the CSS too:
adrientetar@23d07e1#diff-cac2c6f01f5edaa1996dc5a7f34159deL68

@adrientetar
Copy link
Contributor Author

@alexcrichton @brson

@emberian
Copy link
Member

It enables syntax highlighting.

On Wed, Oct 16, 2013 at 6:58 AM, Adrien Tétar [email protected]:

@alexcrichton https://github.com/alexcrichton


Reply to this email directly or view it on GitHubhttps://github.com//pull/9868#issuecomment-26408752
.

@adrientetar
Copy link
Contributor Author

@cmr Nope, tildes are sufficient to enable Rust syntax highlighting (enabled by default), a simple proof of that is that your mentioned snippet is the only one that has the .rust class, but all others in the page are fine (even on current doc).

ex: http://static.rust-lang.org/doc/0.8/rust.html#modules

@brson
Copy link
Contributor

brson commented Oct 16, 2013

Thanks, this is a nice improvement! 🍭

bors added a commit that referenced this pull request Oct 17, 2013
- switch pandoc to HTML5, add tutorial PDF gen.
- cleanup and refactor CSS, expand tutorial/manual CSS +some Bootstrap elements, cleanup unused doc/lib.css

you can see it here in action: http://adrientetar.legtux.org/cached/rust-doc/rust.html
- minor rustdoc cleanups

@alexcrichton
@adrientetar
Copy link
Contributor Author

Not sure what's wrong here, it built fine even before my latest changes on my PC and the error message here is pretty much inexistent.
I'll try to rebuild again.

@adrientetar
Copy link
Contributor Author

Rebased against master, couldn't find any error... bonus: fixed #9911. r?

@adrientetar
Copy link
Contributor Author

@graydon Could you advise with the Makefile issue?
Looking at the file history, you're the main writer of these files and there seem to be odd rules that I'm having a hard time to understand...
http://buildbot.rust-lang.org/builders/auto-linux-64-nopt-t/builds/1146
I must add that it works fine on my PC but fails on the Buildbots...

$(Q)cp -a $< $@ 2> /dev/null

doc/manual.css: manual.css
doc/css/rust.css: rust.css
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this this the problem: rust.css doesn't exist? (Maybe you have an old file called rust.css in some directory?)

(Note: I'm not at all experienced with Makefiles.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this rule is supposed to alias rust.css with it's full path from the main directory, I have moved rust.css to a css/ subfolder hence the change. Now it seems to be broken somehow.

A bit of history:
6bab5c0
5487f14

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also iirc it gave the exact same error when I removed those 3 lines previously @alexcrichton suggested deleting them previously so it might not be the root cause of the error.

bors added a commit that referenced this pull request Oct 19, 2013
This is #9868 but doesn't move css files to a separate subfolder, which was causing errors on the Rust buildbot.

@alexcrichton
@adrientetar
Copy link
Contributor Author

Closed in favor of #9960.

bors added a commit that referenced this pull request Oct 22, 2013
This is #9868 but doesn't move css files to a separate subfolder, which was causing errors on the Rust buildbot.

@alexcrichton
@adrientetar adrientetar deleted the patch-doc branch December 15, 2013 11:49
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

Successfully merging this pull request may close these issues.

7 participants