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

Consider switching to MkDocs for documentation #195

Open
tcbrindle opened this issue Jul 29, 2024 · 0 comments
Open

Consider switching to MkDocs for documentation #195

tcbrindle opened this issue Jul 29, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@tcbrindle
Copy link
Owner

We're currently using Sphinx for our documentation, but it seems like MkDocs -- specifically Material for MkDocs -- is now preferred by many projects.

It certainly does generate very nice, modern looking documentation. Using Markdown by default (rather than RST) would possibly make things easier for new contributors (although we could in principle use Markdown for Sphinx as well). We'd also be able to move away from Sphinx's (sometimes finicky) C++ parser, which might result in more natural (C++-y) looking declarations.

C++ projects using MkDocs include mp-units and {fmt}

@tcbrindle tcbrindle added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 29, 2024
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant