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

set up documentation CI against Julia 1.x #52

Merged
merged 12 commits into from
Sep 3, 2020
Merged

set up documentation CI against Julia 1.x #52

merged 12 commits into from
Sep 3, 2020

Conversation

johnnychen94
Copy link
Collaborator

The whole documentation will be largely rewritten to:

  • update to Julia 1.0
  • better cooperate with current Images.jl
  • be CI-friendly (e.g., replace Weave and optable.jl with DemoCards.jl)

It would be impossible to review if they're all squashed into one PR, so I'll set this as the common base, and make reviewable separate PRs that points to this branch.

P.S. DemoCards doesn't have the full functionality as a jump-in replacement, so I'll need to spend some of my time debugging and enhance it.

@johnnychen94 johnnychen94 added this to the v0.6 milestone Jan 31, 2020
@johnnychen94

This comment has been minimized.

@Evizero
Copy link
Owner

Evizero commented Mar 3, 2020

Grid seems to be a little bit more readable. Any chance you can fix the black background?

@Evizero
Copy link
Owner

Evizero commented Mar 3, 2020

btw. I don't recall to what extend I transferred stuff here, but I do have some doc stuff for augmentor at juliaml: https://github.com/JuliaML/FileStorage/tree/master/Augmentor
In case you wondered how I created some pieces.

I know... I wasn't exactly spending much time on cleaning up my documentation "framework"

@johnnychen94
Copy link
Collaborator Author

johnnychen94 commented Mar 4, 2020

Any chance you can fix the black background?

Yeah, I just tried to make a fresh build of those scripts from scratch with my own stuff. But it's doable --https://github.com/Evizero/Augmentor.jl/blob/master/docs/optable.jl gives a nice example of this already.

There're more details that need to be fixed. This is just a preview of my experiments on the layouts.

I know... I wasn't exactly spending much time on cleaning up my documentation "framework"

😄 that (documentation) was more than elaborative to me

This package is not registered in General so we have to manually
add it
This package is not registered in General
@johnnychen94
Copy link
Collaborator Author

johnnychen94 commented Aug 28, 2020

This is mostly done now.

As a brief summary:

A lot of changes are involved here and it's pretty hard to review them line by line. I would suggest build it locally and view the generated pages.

The ISICArchive.jl package is not registered in General, so I have to hack it a bit in make.jl as a temporary solution (if I don't want to check in Manifest.toml). We should either register this package or replace it with probably TestImages or MLDatasets. I'll leave this to future work. (CRef. Evizero/ISICArchive.jl#3)

@Evizero do you want to take a look at this?

@johnnychen94 johnnychen94 changed the title [WIP] set up documentation CI against Julia 1.0 set up documentation CI against Julia 1.0 Aug 28, 2020
@johnnychen94 johnnychen94 changed the title set up documentation CI against Julia 1.0 set up documentation CI against Julia 1.x Aug 28, 2020
@johnnychen94 johnnychen94 marked this pull request as ready for review August 28, 2020 13:45
@Evizero
Copy link
Owner

Evizero commented Aug 28, 2020

I don't have a local julia installation currently. any chance you can show some screenshots of the major things?

@johnnychen94
Copy link
Collaborator Author

johnnychen94 commented Aug 28, 2020

The biggest changes are on operations. The tutorials are built with DemoCards with a List theme.

Plots, Reel are not used in this PR; instead, I use ImageMagick to generate gifs.


Operations

2020-08-29 04-49-14 2020-08-29 04_50_30

image


Tutorials

Integrate with Flux.jl is not included in this PR:

2020-08-29 12-10-02 2020-08-29 12_10_54

@Evizero
Copy link
Owner

Evizero commented Sep 1, 2020

Looking good. Thank you for all that hard work. Feel free to merge when you are ready

@johnnychen94
Copy link
Collaborator Author

Let me merge this and see if it gets successfully deployed to gh-pages branch

@johnnychen94 johnnychen94 merged commit 951a01d into master Sep 3, 2020
@johnnychen94 johnnychen94 deleted the jc/docs branch September 3, 2020 15:51
@johnnychen94
Copy link
Collaborator Author

deployed in https://evizero.github.io/Augmentor.jl/dev/

@Evizero
Copy link
Owner

Evizero commented Sep 7, 2020

amazing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants