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

Add a rendered version of the documentation to Read the Docs #44

Closed
wants to merge 1 commit into from

Conversation

ericholscher
Copy link

This allows folks to browse the contents in a nicer way,
including with navigation and search.

I made the project, but would be happy to hand over the keys
to folks on the Swift team if you're interested.

You could also CNAME docs.swift.org to this,
and use that as a canonical source if you were interested.

You can see the rendered version here: http://apple-swift.readthedocs.org/en/latest/contents.html

I also added a branch that renders it using our own theme, which I find to be more useful. We could help add some swift branding to it, if you're interested in using it: http://apple-swift.readthedocs.org/en/readthedocs-theme/index.html -- It makes the contents much more readable on mobile as well.

@al45tair
Copy link
Contributor

al45tair commented Dec 4, 2015

The Read the Docs theme version is really good IMO.

@johnantoni
Copy link
Contributor

+1

prefer your theme #44 much more easier on the eyes and scannable

screen shot 2016-02-18 at 12 58 53 pm

@CodaFi
Copy link
Contributor

CodaFi commented Jul 31, 2016

First of all, thank you all for the discussion and for bringing this issue to our attention. I apologize that it took so long for us to get around to reviewing this change. We feel that though readthedocs provides value, it may serve as a distraction from documentation provided by Apple - ultimately, that's the one we want to push users towards. Nevertheless, rehosting our docs with such nice formatting and a friendly interface is a hugely useful thing to have and we may want to put a link on, say, swift.org somewhere instead. With that, I must close this issue.

Please email swift-dev with this, though. I'm sure the community would love to see this.

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.

4 participants