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.

Sign up for GitHub

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

Jump to bottom

Build HTML and publish to Github pages #8

Closed
Timmmm opened this issue Jan 22, 2024 · 4 comments · Fixed by #21
Closed

Build HTML and publish to Github pages #8

Timmmm opened this issue Jan 22, 2024 · 4 comments · Fixed by #21
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Timmmm
Copy link
Contributor

Timmmm commented Jan 22, 2024

It would be nice to extend the Makefile to support building the spec as HTML and publish the result via Github Pages.
@tariqkurd-repo
Copy link
Collaborator

feel free!

@tariqkurd-repo tariqkurd-repo added enhancement New feature or request documentation Improvements or additions to documentation labels Jan 22, 2024
Timmmm added a commit to Timmmm/riscv-cheri that referenced this issue Jan 22, 2024
@Timmmm
Support building HTML output
a816cfe 
Add support for building the HTML version of the specification. By default `make` will still only build the PDF version; `make pdf` or `make html` will build one or the other, and `make all` will build both. `make all` is run in CI.

I also deduplicated the asciidoc commands a bit, and fixed ctrl-c for the docker builds.

See riscv#8
@Timmmm Timmmm mentioned this issue Jan 22, 2024
Merged
Timmmm added a commit to Timmmm/riscv-cheri that referenced this issue Jan 22, 2024
@Timmmm
Support building HTML output
0c3b6e0 
Add support for building the HTML version of the specification. By default `make` will still only build the PDF version; `make pdf` or `make html` will build one or the other, and `make all` will build both. `make all` is run in CI.

I also deduplicated the asciidoc commands a bit, and fixed ctrl-c for the docker builds.

See riscv#8
@arichardson
Copy link
Collaborator

This would be really nice to have! I'm not entierly sure what else needs to be done besides archiving the HTML, but I can see https://github.com/peaceiris/actions-gh-pages which should fix the deployment problem.

Timmmm added a commit to Timmmm/riscv-cheri that referenced this issue Jan 23, 2024
@Timmmm
Support building HTML output
7038c5f 
Add support for building the HTML version of the specification. By default `make` will still only build the PDF version; `make pdf` or `make html` will build one or the other, and `make all` will build both. `make all` is run in CI.

I also deduplicated the asciidoc commands a bit, and fixed ctrl-c for the docker builds.

See riscv#8
Timmmm added a commit to Timmmm/riscv-cheri that referenced this issue Jan 23, 2024
@Timmmm
Support building HTML output
44e0af1 
Add support for building the HTML version of the specification. By default `make` will still only build the PDF version; `make pdf` or `make html` will build one or the other, and `make all` will build both. `make all` is run in CI.

I also deduplicated the asciidoc commands a bit, and fixed ctrl-c for the docker builds.

See riscv#8
@Timmmm
Copy link
Contributor Author

Timmmm commented Jan 23, 2024

Ok I got this to work on my fork. For some reason it deployed here: https://blog.timhutt.co.uk/riscv-cheri/

Hopefully it will deploy somewhere more sensible in this repo! I'll send a PR.

@Timmmm Timmmm mentioned this issue Jan 23, 2024
Merged
@arichardson
Copy link
Collaborator

Seems to be deployed at https://riscv.github.io/riscv-cheri/ now :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Deploy to Github pages on release Timmmm/riscv-cheri
3 participants
@Timmmm @arichardson @tariqkurd-repo