Have the same README both in Markdown and reStructuredText

后端 未结 8 1271
旧时难觅i
旧时难觅i 2020-12-22 16:29

I have a project hosted on GitHub. For this I have written my README using the Markdown syntax in order to have it nicely formatted on GitHub.

As my project is in Py

8条回答
  •  旧巷少年郎
    2020-12-22 16:51

    Using the pandoc tool suggested by others I created a md2rst utility to create the rst files. Even though this solution means you have both an md and an rst it seemed to be the least invasive and would allow for whatever future markdown support is added. I prefer it over altering setup.py and maybe you would as well:

    #!/usr/bin/env python
    
    '''
    Recursively and destructively creates a .rst file for all Markdown
    files in the target directory and below.
    
    Created to deal with PyPa without changing anything in setup based on
    the idea that getting proper Markdown support later is worth waiting
    for rather than forcing a pandoc dependency in sample packages and such.
    
    Vote for
    (https://bitbucket.org/pypa/pypi/issue/148/support-markdown-for-readmes)
    
    '''
    
    import sys, os, re
    
    markdown_sufs = ('.md','.markdown','.mkd')
    markdown_regx = '\.(md|markdown|mkd)$'
    
    target = '.'
    if len(sys.argv) >= 2: target = sys.argv[1]
    
    md_files = []
    for root, dirnames, filenames in os.walk(target):
        for name in filenames:
            if name.endswith(markdown_sufs):
                md_files.append(os.path.join(root, name))
    
    for md in md_files:
        bare = re.sub(markdown_regx,'',md)
        cmd='pandoc --from=markdown --to=rst "{}" -o "{}.rst"'
        print(cmd.format(md,bare))
        os.system(cmd.format(md,bare))
    

提交回复
热议问题