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 website generated with the HTML backend like the stdlib? #17

Closed
ice1000 opened this issue Jan 17, 2019 · 22 comments · Fixed by #687
Closed

Add website generated with the HTML backend like the stdlib? #17

ice1000 opened this issue Jan 17, 2019 · 22 comments · Fixed by #687

Comments

@ice1000
Copy link
Member

ice1000 commented Jan 17, 2019

So we can browse this project easier.

BTW I need an admin (like @UlfNorell) to enable gh-pages rendering for this repo.

@mortberg
Copy link
Collaborator

Can you send me a link so that I can see what it looks like? Also, where would this be hosted?

@ice1000
Copy link
Member Author

ice1000 commented Jan 19, 2019

The stdlib: https://agda.github.io/agda-stdlib

Also we have literate Agda, which allowd us to have: https://ice1000.org/lagda/CubicalAgdaLiterate.html (it's a modified version of your writing! As a CuTT learner, I really appreciate your work!)

@ice1000
Copy link
Member Author

ice1000 commented Jan 19, 2019

Reminder: the codes in both links are clickable.

@ice1000
Copy link
Member Author

ice1000 commented Jan 19, 2019

As you can see from the stdlib's url, you'll know it's gonna be hosted on GitHub Pages.
It's free and https.

@mortberg
Copy link
Collaborator

This looks good. How often does the html pages get generated?

@ice1000
Copy link
Member Author

ice1000 commented Jan 20, 2019

@mortberg We can let the CI do the work. In agda-stdlib, we have a GH_TOKEN global variable that stores someone's GitHub token which has the rights to push to a branch of agda-stdlib.

@ice1000
Copy link
Member Author

ice1000 commented Jan 20, 2019

So every git-push will trigger the change of the website.

@ice1000
Copy link
Member Author

ice1000 commented Sep 9, 2019

I think we can start working on this.

@ayberkt
Copy link
Contributor

ayberkt commented Apr 28, 2020

@ice1000

I think we can start working on this.

I second this and can help set it up if an agreement is reached.

@ice1000
Copy link
Member Author

ice1000 commented Apr 28, 2020

You should @ @mortberg or @Saizan because they have admin access to this repo, I don't

@mortberg
Copy link
Collaborator

What do I need to do? I'm very busy with other things at the moment, so I won't have time to do any work on this until the end of the semester. But if it's just about giving some rights then I can try to do it quickly

@ayberkt
Copy link
Contributor

ayberkt commented May 4, 2020

This is not really an urgent matter and we can address it later. I tried looking at the CI machinery and it seems more complicated than I expected.

Perhaps, someone more familiar with it can tweak it to call agda --html and then tell Travis to publish the generated HTML. I think that should be all? If that's the case, this should be quite easy but as @ice1000 pointed out, GitHub Pages will have to be enabled.

@ice1000
Copy link
Member Author

ice1000 commented May 4, 2020

As well as Travis CI. You need to configure an access token for it

@ice1000
Copy link
Member Author

ice1000 commented Jul 23, 2020

HoTT-Coq has this: HoTT/Coq-HoTT#191

@mortberg
Copy link
Collaborator

@ice1000 If we're going to do anything about this now might be a good time that we're all working on the library at the same time. Do you think we should do something now?

@ice1000
Copy link
Member Author

ice1000 commented Oct 15, 2020

Surely. When do we do that?

@mortberg
Copy link
Collaborator

Maybe Tuesday next week? Do we need to involve someone else?

Note that I'm really clueless about how these things work, but I'm of course happy to help out with providing whatever rights needed to set it up :-)

@ice1000
Copy link
Member Author

ice1000 commented Oct 15, 2020

I guess Tuesday works for me, let's see :) I'll try to reach you on AIM.

@ayberkt
Copy link
Contributor

ayberkt commented Feb 23, 2021

Until this issue is addressed, those who would like to browse cubical in HTML can use the pages that are automatically generated when I generate HTML from my development that uses cubical.

@ice1000
Copy link
Member Author

ice1000 commented Feb 23, 2021

Similarly I have this page

@brendanzab
Copy link

brendanzab commented Apr 19, 2021

Just wanna say that this would be greatly appreciated! I've been really glad that the generated Agda Categories sources are available on Github Pages - it's much easier to navigate those as opposed to the sources on Github.

@brendanzab
Copy link

brendanzab commented Jan 2, 2022

If you are already using github pages then you might be able to use this action to deploy in a pretty pain-free way (I don't think it even requires a token now). I'd recommend making a .github/workflows/cd-ubuntu.yaml file that runs on pushes to master, builds the HTML doc, then runs the JamesIves/github-pages-deploy-action to upload the output directory to pages. Here's an example of what I set up for another (non-Agda) project: https://github.com/brendanzab/ocaml-flake-example/blob/main/.github/workflows/cd.yml

@ice1000 ice1000 linked a pull request Jan 3, 2022 that will close this issue
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 a pull request may close this issue.

4 participants