I'd encourage everyone looking to get started to give mkdocs a try. Just because Sphinx is the de facto standard doesn't mean it's the best. If you're already comfortable with markdown (which is used on gitlab, github, Reddit, dev.to, etc.) and it makes it easier for you to write documentation, don't let RST get in the way. Both tools are fine, IMO, but I have found mkdocs much simpler.
👋 Hey there, I am Waylon Walker
I am a Husband, Father of two beautiful children, Senior Python Developer currently working in the Data Engineering platform space. I am a continuous learner, and sha
For being a documentation library sphinx has some ironically confusing docs! It is so powerful when set up right, but I find myself needing to dig through a bunch of open source projects to decypher how to use it without a bunch of manual work.
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
I'd encourage everyone looking to get started to give mkdocs a try. Just because Sphinx is the de facto standard doesn't mean it's the best. If you're already comfortable with markdown (which is used on gitlab, github, Reddit, dev.to, etc.) and it makes it easier for you to write documentation, don't let RST get in the way. Both tools are fine, IMO, but I have found mkdocs much simpler.
Thanks, this is valuable info for me! I might update my main post.
Note that I'm not saying there's anything wrong with Sphinx 😄
When I wanted to document my projects, I simply wanted the easier option.
For being a documentation library sphinx has some ironically confusing docs! It is so powerful when set up right, but I find myself needing to dig through a bunch of open source projects to decypher how to use it without a bunch of manual work.