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

Migrate GitHub Pages site to Material for MkDocs #173

Closed
1 task
thobson88 opened this issue Apr 6, 2024 · 4 comments · Fixed by #186
Closed
1 task

Migrate GitHub Pages site to Material for MkDocs #173

thobson88 opened this issue Apr 6, 2024 · 4 comments · Fixed by #186
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@thobson88
Copy link
Collaborator

thobson88 commented Apr 6, 2024

Started on branch mkdocs.

Instructions here: https://squidfunk.github.io/mkdocs-material/getting-started/

  • once installed, serve locally by first activating the right Python environment and then mkdocs serve.

TODO:

  • Add a friendly (non-techie) video of the mobile app demo to the intro page
@thobson88 thobson88 self-assigned this Apr 7, 2024
@thobson88 thobson88 added the documentation Improvements or additions to documentation label Apr 7, 2024
@thobson88
Copy link
Collaborator Author

thobson88 commented Jul 17, 2024

This is ready to deploy. I've added a CI workflow as per these instructions.

PR here: #186

sgreenbury added a commit that referenced this issue Jul 17, 2024
New documentation site built with Material for MkDocs (#173)
@thobson88
Copy link
Collaborator Author

thobson88 commented Jul 17, 2024

Deployment didn't work (with the theme correctly displayed) until I followed this advice.

In particular, this bit in repo > Settings > Pages:
Screenshot 2024-07-17 at 15 45 16

@thobson88
Copy link
Collaborator Author

thobson88 commented Jul 17, 2024

With the settings above, I'm not sure whether the CI for docs deployment is working. I doubt it because I'm using the alternative "manual" deployment method with the built site landing on the gh-pages branch.

In that case, to update the deployed site it's just:

mkdocs gh-deploy --force

UPDATE: turns out the CI does work. Changes pushed/merged to main appear automatically on the deployed site (after a minute or so).

@thobson88
Copy link
Collaborator Author

Closing this and opening a new ticket for the demo video idea.

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

Successfully merging a pull request may close this issue.

1 participant