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 Sqhinx docs instead of mkdocs #434

Merged
merged 5 commits into from
Sep 29, 2024
Merged

Use Sqhinx docs instead of mkdocs #434

merged 5 commits into from
Sep 29, 2024

Conversation

michaeldeistler
Copy link
Contributor

@michaeldeistler michaeldeistler commented Sep 27, 2024

This changes our documentation from mkdocs to sphinx. This has two benefits:

  1. it looks more professional (see screenshot below)
  2. we can host the documentation on readthedocs.

Screenshot 2024-09-28 at 14 01 18

I moved the old documentation to mkdocs and will remove it in a future PR (I just want to keep it for now such that we can still use the old website in case anything goes wrong with readthedocs).

@michaeldeistler michaeldeistler merged commit e7d76fa into main Sep 29, 2024
1 check passed
@michaeldeistler michaeldeistler deleted the sqhynxdocs branch September 29, 2024 12:55
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.

1 participant