Jekyll vs. Sphinx about cookiecutter-pyvanguard

[clayrisser]

Sphynx supports markdown
http://www.sphinx-doc.org/en/stable/markdown.html

[thinkhuman]

You might want to check out Mkdocs (here on Github). Python-based, like Sphinx, but takes Markdown. For me, The requirement for reStructuredText is a deal-breaker on Sphinx. I want Markdown, period. It's a fast, easy, flexible source format.

Also, check out this nifty and promising project:
https://github.com/tomjohnson1492/documentation-theme-jekyll

[robinandeer]

I'm actually a contributor and have been using MkDocs in some recent projects 😄

I think it's really nice to strive in this template to keep everything Python-native. MkDocs will probably replace Sphinx for me in the near future as I agree that writing Markdown is a "deal maker".

Thanks for the reminder!

[robinandeer]

Hmm that looks interesting!

I do kind of like how Sphinx ties your source code with docs although I've mostly switched to using GitBook for more recent projects. Markdown support is a requirement either way.

Might be time to make a push on this project and look around how Python development has changed since last.

[maxatka]

My 5 cents for Sphinx:
https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html