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

WIP: transitioning docs to Documenter.jl #879

Merged
merged 12 commits into from
Sep 8, 2016

Conversation

tlnagy
Copy link
Member

@tlnagy tlnagy commented Aug 23, 2016

Working on #878. This fixes #852, #865, and probably many others.

screen shot 2016-08-22 at 23 10 40

Couple things left

@tlnagy
Copy link
Member Author

tlnagy commented Aug 23, 2016

@rsrock, @shashi, @timholy I would appreciate any thoughts/comments!

@coveralls
Copy link

coveralls commented Aug 23, 2016

Coverage Status

Coverage increased (+0.01%) to 65.451% when pulling 2866453 on tlnagy:pull-request/2866453a into 4a36837 on dcjones:master.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.01%) to 65.451% when pulling 4c7be36 on tlnagy:pull-request/2866453a into 4a36837 on dcjones:master.

1 similar comment
@coveralls
Copy link

coveralls commented Aug 23, 2016

Coverage Status

Coverage increased (+0.01%) to 65.451% when pulling 4c7be36 on tlnagy:pull-request/2866453a into 4a36837 on dcjones:master.

@Hydrotoast
Copy link
Contributor

Which theme are you using here? This appears to be slightly different from the readthedocs theme.

@tlnagy
Copy link
Member Author

tlnagy commented Aug 24, 2016

It is the default theme for the HTML output of Documenter.jl (I'm not
using MkDocs).

On Tue, Aug 23, 2016, at 21:39, Gio Borje wrote:

Which theme are you using here? This appears to be slightly different
from the readthedocs theme.
— You are receiving this because you authored the thread. Reply to
this email directly, view it on GitHub[1], or mute the thread[2].

@tlnagy
Copy link
Member Author

tlnagy commented Aug 24, 2016

@shashi Do you have access to the travis keys for this project? It would be awesome to set up CI to autogenerate the docs and have the latest/stable versions. See https://juliadocs.github.io/Documenter.jl/latest/man/hosting.html#Deploy-Keys-1

@rsrock
Copy link

rsrock commented Aug 25, 2016

Is there any way to look at this live? Can you set it up on your fork?

Looks great!

@tlnagy
Copy link
Member Author

tlnagy commented Aug 25, 2016

I'll see what I can do

@tlnagy
Copy link
Member Author

tlnagy commented Aug 25, 2016

I'll build it locally and push it to my gh-pages branch, but it's crashing right now due to bugs in Gadfly, specifically waiting for my fix at #884 to get merged. I'll let you know once I have a live version up and running.

@tlnagy
Copy link
Member Author

tlnagy commented Aug 25, 2016

@rsrock Here's a live demo: http://tamasnagy.com/Gadfly.jl/

@coveralls
Copy link

coveralls commented Aug 26, 2016

Coverage Status

Coverage remained the same at 65.603% when pulling 62ac676 on tlnagy:pull-request/2866453a into f6183ac on dcjones:master.

@rsrock
Copy link

rsrock commented Aug 27, 2016

Man, this is nice. I'd like it if this was merged as soon as you're ready. Great work!

@tlnagy
Copy link
Member Author

tlnagy commented Aug 27, 2016

Thanks! 🎉

I'm waiting for #885 to merge and then all the docs can be built on master. Also, I might wait till @MichaelHatherly gets a chance to sort out the navbar stuff because that's a bit too hairy to merge right now.

@coveralls
Copy link

coveralls commented Aug 27, 2016

Coverage Status

Coverage remained the same at 65.603% when pulling 771979a on tlnagy:pull-request/2866453a into f6183ac on dcjones:master.

@shashi
Copy link
Collaborator

shashi commented Aug 30, 2016

I'm trying to follow the instructions on setting up Documenter.jl with travis, but failing.

SSL error: could not verify peer
ERROR: failed process: Process(`travis login --auto`, ProcessExited(1)) [1]
 in pipeline_error(::Base.Process) at ./process.jl:612
 in run at ./process.jl:588 [inlined]
 in (::Documenter.Travis.##1#2)() at /home/shashi/.julia/v0.5/Documenter/src/Documenter.jl:461
 in cd(::Documenter.Travis.##1#2, ::String) at ./file.jl:59
 in genkeys(::String) at /home/shashi/.julia/v0.5/Documenter/src/Documenter.jl:458

I've tried everything mentioned here travis-ci/travis.rb#141 but it hasn't worked.

@tlnagy
Copy link
Member Author

tlnagy commented Aug 30, 2016

Have you considered opening up an issue with https://github.com/JuliaDocs/Documenter.jl? It might be that Travis.genkeys doesn't work unless you're the owner of the repo. Collaborators might not have access. Maybe @MichaelHatherly knows?

@MichaelHatherly
Copy link

I've not come across that error before. @shashi, does Travis.genkeys work for a repo that you're an owner of? Could possibly also be due to an old version of travis, was it installed via gem install, or via a distro package manager?

@shashi
Copy link
Collaborator

shashi commented Aug 31, 2016

It doesn't work on packages I own either... I will try a different machine today.

@tlnagy
Copy link
Member Author

tlnagy commented Sep 1, 2016

So my understanding is that we need to add the ssh keys in the repo's settings. I don't think either or @shashi or I have access to that. We might need to ping Daniel and give him the ssh key to add.

@coveralls
Copy link

coveralls commented Sep 1, 2016

Coverage Status

Coverage remained the same at 65.742% when pulling 6c55b86 on tlnagy:pull-request/2866453a into 81ef863 on dcjones:master.

@tlnagy
Copy link
Member Author

tlnagy commented Sep 7, 2016

This is basically ready to go, currently waiting for upstream fixes for broken Gadfly tests, see #890. The last remaining TODO item is an aesthetics thing that is upstream of this PR so I'm fine with this merging.

@coveralls
Copy link

coveralls commented Sep 8, 2016

Coverage Status

Coverage remained the same at 65.785% when pulling 8ec1f6a on tlnagy:pull-request/2866453a into 24edf01 on dcjones:master.

@tlnagy tlnagy merged commit 8349691 into GiovineItalia:master Sep 8, 2016
@tlnagy tlnagy deleted the pull-request/2866453a branch April 4, 2018 00:37
tlnagy added a commit that referenced this pull request Apr 4, 2018
must've slipped in with the original doc fixes in #879
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.

Theme documentation outdated
7 participants