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

Update documentation tooling recommendations #187

Closed
matt-graham opened this issue Oct 24, 2023 · 3 comments · Fixed by #327
Closed

Update documentation tooling recommendations #187

matt-graham opened this issue Oct 24, 2023 · 3 comments · Fixed by #327
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@matt-graham
Copy link
Collaborator

matt-graham commented Oct 24, 2023

@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.

@matt-graham matt-graham added documentation Improvements or additions to documentation question Further information is requested labels Oct 24, 2023
@p-j-smith
Copy link
Contributor

p-j-smith commented Oct 24, 2023

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

@paddyroddy
Copy link
Member

Yeah, I would actually play MkDocs way ahead of sphinx. Most people's views on sphinx come from the fact that it is much more mature, and comparisons are largely from when MkDocs was in its infancy. I think we should make our cookie docs in #115 in MkDocs personally.

@matt-graham
Copy link
Collaborator Author

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 autodoc is a built-in extension in Sphinx, while mkdocstrings is a relatively young project and most of development seems to be by one main contributor. There is some interesting related discussion here. I'd personally err towards recommending both with an explanation of something like

Sphinx is the de-facto standard that is widely used. It is well tested, reliable and very customisable.
Mkdocs is a more recent but still relatively mature documentation system that can be simpler to set up than Sphinx.

samcunliffe added a commit that referenced this issue Mar 24, 2024
Fixes #187.
Relates to #16, #318, and #319. See discussion in #16.
Depends on #319.
@samcunliffe samcunliffe linked a pull request Mar 24, 2024 that will close this issue
@samcunliffe samcunliffe self-assigned this Mar 24, 2024
samcunliffe added a commit that referenced this issue Mar 25, 2024
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 <matthew.m.graham@gmail.com>
Co-authored-by: David Stansby <dstansby@gmail.com>
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 question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants