Python ReadmeMaker.examples_dir_name Examples

Example #1

File: make_readme.py Project: yym1995/tcconfig

def main():
    maker = ReadmeMaker(
        PROJECT_NAME,
        OUTPUT_DIR,
        is_make_toc=True,
        project_url="https://github.com/thombashi/{}".format(PROJECT_NAME),
    )
    maker.examples_dir_name = "usage"

    maker.write_chapter("Summary")
    maker.write_introduction_file("summary.txt")
    maker.write_introduction_file("badges.txt")
    maker.write_introduction_file("feature.txt")

    maker.write_lines([".. image:: docs/gif/tcset_example.gif"])

    write_examples(maker)

    maker.write_lines([])
    maker.write_file(maker.doc_page_root_dir_path.joinpath("installation.rst"))

    maker.set_indent_level(0)
    maker.write_chapter("Documentation")
    maker.write_lines(["https://{:s}.rtfd.io/".format(PROJECT_NAME)])

    maker.write_chapter("Troubleshooting")
    maker.write_lines([
        "https://{:s}.rtfd.io/en/latest/pages/troubleshooting.html".format(
            PROJECT_NAME)
    ])

    maker.write_chapter("Docker image")
    maker.write_lines(["https://hub.docker.com/r/thombashi/tcconfig/"])

    return 0

Example #2

File: make_readme.py Project: xNathan/pingparsing

def main():
    maker = ReadmeMaker(
        PROJECT_NAME,
        OUTPUT_DIR,
        is_make_toc=True,
        project_url="https://github.com/thombashi/{}".format(PROJECT_NAME),
    )
    maker.examples_dir_name = "usage"

    maker.write_chapter("Summary")
    maker.write_introduction_file("summary.txt")
    maker.write_introduction_file("badges.txt")

    write_examples(maker)

    maker.write_introduction_file("installation.rst")
    maker.write_introduction_file("supported_environment.txt")
    maker.write_file(maker.doc_page_root_dir_path.joinpath("introduction/premise.txt"))

    maker.set_indent_level(0)
    maker.write_chapter("Documentation")
    maker.write_lines(["https://{:s}.rtfd.io/".format(PROJECT_NAME)])

    maker.write_file(maker.doc_page_root_dir_path.joinpath("sponsors.rst"))

    return 0

Example #3

File: make_readme.py Project: thombashi/sqlitebiter

def main():
    maker = ReadmeMaker(
        PROJECT_NAME,
        OUTPUT_DIR,
        is_make_toc=True,
        project_url="https://github.com/thombashi/{}".format(PROJECT_NAME),
    )
    maker.examples_dir_name = "usage"

    maker.write_chapter("Summary")
    maker.write_introduction_file("summary.txt")
    maker.write_introduction_file("badges.txt")
    maker.write_introduction_file("feature.txt")

    write_examples(maker)

    maker.write_file(maker.doc_page_root_dir_path.joinpath("installation.rst"))

    maker.set_indent_level(0)
    maker.write_chapter("Documentation")
    maker.write_lines(["https://{:s}.rtfd.io/".format(PROJECT_NAME.lower())])

    return 0