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

Use 'just-the-docs' theme for GitHub pages. #79

Merged
merged 13 commits into from
Jan 14, 2025
Merged

Conversation

cwize1
Copy link
Contributor

@cwize1 cwize1 commented Jan 10, 2025

Replace the GitHub pages Jekyll theme with 'just-the-docs'. This theme has an inbuilt navigation bar. It also seems to have good browser width handling.

In addition, add a Gemfile and Makefile for the docs generation.


Checklist

  • Tests added/updated
  • Documentation updated (if needed)
  • Code conforms to style guidelines

@cwize1 cwize1 requested a review from a team as a code owner January 10, 2025 01:36
Copy link
Contributor

@romoh romoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The github workflow is broken.
I think you need to switch to different github actions to deploy the new theme.

@cwize1 cwize1 force-pushed the user/chrisgun/docstheme branch from 10c38e2 to dcda35f Compare January 10, 2025 20:11
@romoh romoh self-requested a review January 10, 2025 20:23
@cwize1 cwize1 marked this pull request as draft January 11, 2025 00:51
.github/workflows/build-and-test.yml Fixed Show fixed Hide fixed
.github/workflows/docs-build.yml Fixed Show fixed Hide fixed
@cwize1 cwize1 marked this pull request as ready for review January 11, 2025 02:00
romoh
romoh previously approved these changes Jan 11, 2025
cwize1 added 13 commits January 13, 2025 15:31
Replace the GitHub pages Jekyll theme with 'just-the-docs'. This theme
has an inbuilt navigation bar. It also seems to have good browser width
handling.

In addition, add a Gemfile and Makefile for the docs generation.
@cwize1 cwize1 merged commit 879b5e7 into main Jan 14, 2025
7 checks passed
@cwize1 cwize1 deleted the user/chrisgun/docstheme branch January 14, 2025 00:56
elainezhao1 pushed a commit that referenced this pull request Jan 23, 2025
Replace the GitHub pages Jekyll theme with 'just-the-docs'. This theme
has an inbuilt navigation bar. It also seems to have good browser width
handling.

In addition, add a Gemfile and Makefile for the docs generation.
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.

2 participants