cookiecutter-djangopackage icon indicating copy to clipboard operation
cookiecutter-djangopackage copied to clipboard

Add option to create .md files instead of .rst

Open ssteinerx opened this issue 6 years ago • 2 comments

Description

I would like to use README.md instead of README.rst. Same for all of the other root doc files (AUTHORS etc.). It's a pain in the neck right now to chase down every .rst file usage and change to .md everywhere by hand.

I would propose to add the option of using the ".md" extension rather than ".rst" as a cookiecutter option to be used for all top-level files and to properly intertwangle that change into e.g. setup.py.

This might even be better done in the main cookiecutter itself as I'd guess it's a fairly common thing these days with Markdown having become much more the standard in the non-Python centric world and mostly even there except for Python project "docs" directory where Sphinx still rules the roost.

I'd be happy to take this on, but want to make sure it's not something better done in a fork that only I will use...

ssteinerx avatar Aug 09 '17 12:08 ssteinerx

Sounds good to me!

pydanny avatar Aug 09 '17 17:08 pydanny

Should I move this up the tree and, if so, whereto? I think cookiecutter is pretty language agnostic, so I don't think it's inclined to generate .rst files anyway.

Seems like it's kind of mangled into the template to the extent that the docs/*.rst has to be changed to docs/*.{{markdown_or_restructured_extension}}.

Too bad there's not a Cookiecutter Mixin where you could e.g. mix in from TheUsualRootDocs, to include AUTHORS.{{markdown_or_restructured_extension}}, LICENSE and so forth, then mixin PythonSphinxDocsDirectory and get the normal Sphinx setup referencing the correct files from the project root by {{markdown_or_restructured_extension}} with the Sphinx files all being their conventional .rst selves.

You could even have a PythonSomeOtherToolDocsDirectory mixin with a complete documentation setup using some other tool!

ssteinerx avatar Aug 17 '17 13:08 ssteinerx