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

Deploying HTML documentation (website) #8

Closed
palmskog opened this issue Feb 24, 2020 · 1 comment · Fixed by #9
Closed

Deploying HTML documentation (website) #8

palmskog opened this issue Feb 24, 2020 · 1 comment · Fixed by #9

Comments

@palmskog
Copy link
Member

As per #7, we can use the gh-pages branch of the repo to deploy static HTML, which will then appear at the URL https://coq-community.github.io/reglang

If this is done for every revision (i.e., new documentation deployment), the repo can grow to the point of becoming very inconvenient to clone, which has happened to https://github.com/HoTT/HoTT

Hence, the compromise we use in coq-community is to advocate deployment of documentation only for releases of a project, or putting documentation in a separate repo. Here is one example of a landing page: https://coq-community.github.io/lemma-overloading/

Any preferences here @chdoc, is the standard landing page OK with you?

@chdoc
Copy link
Member

chdoc commented Feb 24, 2020

Deployment for every release should be sufficient, and the standard landing page looks fine for me. Indeed, the mathcomp landing page looks very similar. Once I have a bit more time, I might extend it with a library graph with clickable nodes (cf. our graph theory development), maybe even though an extended alternative template.

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.

2 participants