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

Switch documentation to mkdocs + mkdocs material #147

Open
schlegelp opened this issue Apr 9, 2024 · 1 comment
Open

Switch documentation to mkdocs + mkdocs material #147

schlegelp opened this issue Apr 9, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@schlegelp
Copy link
Collaborator

schlegelp commented Apr 9, 2024

This is a pain in the neck but I think migrating to mkdocs would pay off in the long run:

  1. The build process is so much smoother and faster than Sphinx + RTD (live preview!)
  2. Much more modern look and feel
  3. API documentation (via mkdocstrings) is just incredible
  4. Markdown instead of freaking RST

and the lost goes on....

As an example, check out the docs for Octarine I cobbled together over a weekend.

@schlegelp schlegelp added the enhancement New feature or request label Apr 9, 2024
@ceesem
Copy link

ceesem commented Apr 9, 2024

Having started down this path ourselves, it's less of a pain in the neck than you'd think and this sort of conversion is exactly in the wheelhouse of LLMs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants