-
Notifications
You must be signed in to change notification settings - Fork 2
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
Update documentation tooling recommendations #187
Comments
Yeah I agree, I used Mkdocs for the first time recently and really like it. I would probably even suggest using it over Sphinx if someone is not familiar with either of them |
Yeah, I would actually play |
I don't have strong opinions favouring Sphinx, but I think much more mature is a valid reason to favour one tool over another for a default recommendation. Sphinx has more regular contributors than MkDocs and is more widely used, so I'd say it's less at risk of becoming non-maintained. For generating API documentation
|
Following the discussion in #16, I've tried to summarise (and might have quoted you directly 😄). Picky comments very gratefully received. ## Fixes - #187 ## Relates to - #16 - #318 - #319 --------- Co-authored-by: Matt Graham <[email protected]> Co-authored-by: David Stansby <[email protected]>
@paddyroddy and I think we should maybe switch to recommending both Mkdocs and Sphinx as 🟢 as they seem to offer similar level of functionality / extensions and both are mature / well used.
The text was updated successfully, but these errors were encountered: