feat(docs): rename generated markdown index to shuttle_index.md

This commit is contained in:
Uri Shaked
2023-12-23 13:04:18 +02:00
parent 47644b5d71
commit 0ea5cec65d
3 changed files with 5 additions and 5 deletions
+4 -4
View File
@@ -20,11 +20,11 @@ class Docs:
self.script_dir = os.path.dirname(os.path.realpath(__file__))
# stuff related to docs
def build_index(self):
logging.info("building doc index")
def build_index(self, filename="shuttle_index.md"):
logging.info(f"building {filename}")
repo = git.Repo(".")
readme = self.load_doc_template("README_init.md")
with open("README.md", "w") as fh:
readme = self.load_doc_template("shuttle_index_header.md")
with open(filename, "w") as fh:
fh.write(
readme.format(
name=self.config["name"],