Skip to content
This repository was archived by the owner on May 11, 2022. It is now read-only.

Commit 2599861

Browse files
authored
Added Credit to the Bottom of Each README (#36)
* Added a credit line to the READMEs * Updated version
1 parent 44e9464 commit 2599861

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

generate_docs/readme.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ def _generate_program_list(language: LanguageCollection) -> list:
3535
return list_items
3636

3737

38+
def _generate_credit():
39+
return """This page was generated automatically by the Sample Programs Docs Generator.
40+
Find out how to support this project [here](https://github.com/TheRenegadeCoder/sample-programs-docs-generator)."""
41+
42+
3843
class ReadMeCatalog:
3944
"""
4045
An representation of the collection of READMEs in the Sample Programs repo.
@@ -62,6 +67,7 @@ def _build_readme(self, language: LanguageCollection) -> None:
6267
page.add_section_break()
6368
page.add_content(*_generate_program_list(language))
6469
page.add_section_break()
70+
page.add_content(_generate_credit())
6571
self.pages[language.name] = page
6672

6773
def _build_readmes(self) -> None:

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name="generate_docs",
8-
version="2.0.3",
8+
version="2.1.0",
99
author="The Renegade Coder",
1010
author_email="jeremy.grifski@therenegadecoder.com",
1111
description="A docs generation package for the Sample Programs repo",

0 commit comments

Comments
 (0)