-
Notifications
You must be signed in to change notification settings - Fork 69
Adding zensical note, and aligning order of docs between sphinx and m⦠#688
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
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -42,8 +42,7 @@ generator via [mkdocs-material][]. | |
| For more details, examples to help you pick between Sphinx and MkDocs (and | ||
| instructions for the latter), see the [documentation guide][]. For this simple | ||
| introduction, we will use Sphinx as it is still more popular with scientific | ||
| libraries, even though MkDocs is simpler to set up and more popular in general | ||
| with Python documentation. | ||
|
Comment on lines
-45
to
-46
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah I was just assuming before that stars were a proportional proxy to number of projects using it (as mkdocs-material has >3x the number of stars as sphinx). But obviously there are probably (exactly) one billion older projects that just use Sphinx out of the box without ever needing to go and find it on github and press the star button. Also read over it and thought "That is way too strong an opinion to have and espouse!"
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Stars are more of a measure of "ohh, that looks interesting, I'll save it for later" than actual usage. I've got lots of stars that are on projects I thought looked interesting, but I've never used. Compare pip and uv, and pip last I checked was still 75% or so of downloads from PyPI (though getting that high in so short of a time is nothing short of amazing on uv's part, still!) Also there are Python projects with more stars than Python itself; it's also often a "reward" for looking cool/new/exciting.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These are words I will repeat to myself about why even though my projects have few stars they might still have millions of users ;) |
||
| libraries. | ||
|
|
||
| Please refer to the MyST documentation for more information on the Markdown | ||
| syntax in general and MyST's flavor of Markdown in particular. | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.