Skip to content
This repository was archived by the owner on Aug 22, 2023. It is now read-only.

Use mkdocs and add gitpod configuration #29

Merged
merged 5 commits into from
Oct 24, 2022
Merged

Use mkdocs and add gitpod configuration #29

merged 5 commits into from
Oct 24, 2022

Conversation

osfanbuff63
Copy link
Member

@osfanbuff63 osfanbuff63 commented Oct 21, 2022

Resolves #22.

Adds mkdocs using the material theme, and mkdocstrings
to auto-generate references from the code.

This also adds an actions workflow to deploy the docs to Pages whenever a commit to main is pushed. You may need to enable Pages and set it to deploy using GitHub Actions, but this might be done automatically with actions/configure-pages.

In addition, I've added a gitpod configuration.

I've made this a PR as it's quite big, so just to not throw anyone else off this is a different branch.

@osfanbuff63 osfanbuff63 added this to the Full Release milestone Oct 21, 2022
@osfanbuff63 osfanbuff63 changed the title Use mkdocs Use mkdocs and add gitpod configuration Oct 21, 2022
Copy link
Contributor

@nsde nsde left a comment

Choose a reason for hiding this comment

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

I don't know about the last change with the main.py. Maybe we should except both? Is the exception type OS-dependent?

Apart from that, LGTM.

@osfanbuff63
Copy link
Member Author

I don't know about the last change with the main.py. Maybe we should except both? Is the exception type OS-dependent?

Apart from that, LGTM.

The OSError class is the base for both WinError and probably something similar for Unix-based systems. The FileNotFoundError should be derived from OSError so we should be fine, but that's a change for another day I guess.

@osfanbuff63 osfanbuff63 requested a review from nsde October 23, 2022 11:23
@osfanbuff63
Copy link
Member Author

@nsde should we just merge this or do you have anything else to say?

@nsde
Copy link
Contributor

nsde commented Oct 24, 2022

@nsde should we just merge this or do you have anything else to say?

I dunno

@nsde nsde merged commit e8cda1d into main Oct 24, 2022
@osfanbuff63 osfanbuff63 deleted the feat/mkdocs branch October 24, 2022 21:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request]: Use mkdocs
2 participants