1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
|
# holidays
# --------
# A fast, efficient Python library for generating country, province and state
# specific sets of holidays on the fly. It aims to make determining whether a
# specific date is a holiday as fast and flexible as possible.
#
# Authors: Vacanza Team and individual contributors (see CONTRIBUTORS file)
# dr-prodigy <dr.prodigy.github@gmail.com> (c) 2017-2023
# ryanss <ryanssdev@icloud.com> (c) 2014-2017
# Website: https://github.com/vacanza/holidays
# License: MIT (see LICENSE file)
"""Generate SUMMARY.md for literate-nav with list of the countries and markets files."""
from pathlib import Path
import mkdocs_gen_files
def main():
root = Path(__file__).parents[2] # project folder
holidays_path = root / "holidays"
entities_data = [
"* [Overview](index.md)",
"* [Additional Examples](examples.md)",
"* [Contributing](contributing.md)",
"* [API Reference](api.md)",
"* [Mixins](mixins.md)",
"* Supported Entities",
]
for entity_type in ("countries", "financial"):
entities_data.append(f" * holidays.{entity_type}")
for path in sorted((holidays_path / entity_type).rglob("*.py")):
file_name = path.stem
if file_name == "__init__":
continue
entities_data.append(f" * [{file_name}](auto_gen_docs/{file_name}.md)")
entities_data.append("* [Changelog](changelog.md)")
with mkdocs_gen_files.open("SUMMARY.md", "w") as f:
f.write("\n".join(entities_data))
if __name__ in {"__main__", "<run_path>"}:
main()
|