From dff715aaa67f12b10746df3bfff1fc7c6add174e Mon Sep 17 00:00:00 2001 From: Nanda Scott Date: Sun, 28 Oct 2018 01:52:40 -0400 Subject: [PATCH] Updated docs for better formatting --- docs/scrython.bulk_data/BulkData.md | 4 +- docs/scrython.cards/ArenaId.md | 4 +- docs/scrython.cards/Autocomplete.md | 4 +- docs/scrython.cards/Collector.md | 4 +- docs/scrython.cards/Id.md | 4 +- docs/scrython.cards/Mtgo.md | 4 +- docs/scrython.cards/Multiverse.md | 4 +- docs/scrython.cards/Named.md | 4 +- docs/scrython.cards/Random.md | 4 +- docs/scrython.cards/Search.md | 4 +- docs/scrython.catalog/ArtifactTypes.md | 4 +- docs/scrython.catalog/ArtistNames.md | 4 +- docs/scrython.catalog/CardNames.md | 4 +- docs/scrython.catalog/CreatureTypes.md | 4 +- docs/scrython.catalog/EnchantmentTypes.md | 4 +- docs/scrython.catalog/LandTypes.md | 4 +- docs/scrython.catalog/Loyalties.md | 4 +- docs/scrython.catalog/PlaneswalkerTypes.md | 4 +- docs/scrython.catalog/Powers.md | 4 +- docs/scrython.catalog/SpellTypes.md | 4 +- docs/scrython.catalog/Toughnesses.md | 4 +- docs/scrython.catalog/Watermarks.md | 4 +- docs/scrython.catalog/WordBank.md | 4 +- docs/scrython.rulings/Code.md | 4 +- docs/scrython.rulings/Id.md | 4 +- docs/scrython.rulings/Mtgo.md | 4 +- docs/scrython.rulings/Multiverse.md | 4 +- docs/scrython.sets/Code.md | 4 +- docs/scrython.sets/Sets.md | 4 +- docs/scrython.symbology/ParseMana.md | 4 +- docs/scrython.symbology/Symbology.md | 4 +- gen_docs.py | 113 --------------------- 32 files changed, 62 insertions(+), 175 deletions(-) delete mode 100644 gen_docs.py diff --git a/docs/scrython.bulk_data/BulkData.md b/docs/scrython.bulk_data/BulkData.md index b35808c..f1ee7af 100644 --- a/docs/scrython.bulk_data/BulkData.md +++ b/docs/scrython.bulk_data/BulkData.md @@ -1,8 +1,8 @@ # **class** `scrython.bulk_data.BulkData()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`BulkData().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`BulkData().scryfallJson`). ## Args diff --git a/docs/scrython.cards/ArenaId.md b/docs/scrython.cards/ArenaId.md index 78d9aa2..9912fe7 100644 --- a/docs/scrython.cards/ArenaId.md +++ b/docs/scrython.cards/ArenaId.md @@ -1,8 +1,8 @@ # **class** `scrython.cards.ArenaId()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ArenaId().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ArenaId().scryfallJson`). ## Args diff --git a/docs/scrython.cards/Autocomplete.md b/docs/scrython.cards/Autocomplete.md index 30efd25..652c99b 100644 --- a/docs/scrython.cards/Autocomplete.md +++ b/docs/scrython.cards/Autocomplete.md @@ -1,8 +1,8 @@ # **class** `scrython.cards.Autocomplete()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Autocomplete().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Autocomplete().scryfallJson`). ## Args diff --git a/docs/scrython.cards/Collector.md b/docs/scrython.cards/Collector.md index 84bcb7a..a13ce27 100644 --- a/docs/scrython.cards/Collector.md +++ b/docs/scrython.cards/Collector.md @@ -1,8 +1,8 @@ # **class** `scrython.cards.Collector()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Collector().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Collector().scryfallJson`). ## Args diff --git a/docs/scrython.cards/Id.md b/docs/scrython.cards/Id.md index 23a1940..29202c9 100644 --- a/docs/scrython.cards/Id.md +++ b/docs/scrython.cards/Id.md @@ -1,8 +1,8 @@ # **class** `scrython.cards.Id()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Id().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Id().scryfallJson`). ## Args diff --git a/docs/scrython.cards/Mtgo.md b/docs/scrython.cards/Mtgo.md index d49425c..353827c 100644 --- a/docs/scrython.cards/Mtgo.md +++ b/docs/scrython.cards/Mtgo.md @@ -1,8 +1,8 @@ # **class** `scrython.cards.Mtgo()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Mtgo().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Mtgo().scryfallJson`). ## Args diff --git a/docs/scrython.cards/Multiverse.md b/docs/scrython.cards/Multiverse.md index 60c6d69..208a493 100644 --- a/docs/scrython.cards/Multiverse.md +++ b/docs/scrython.cards/Multiverse.md @@ -1,8 +1,8 @@ # **class** `scrython.cards.Multiverse()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Multiverse().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Multiverse().scryfallJson`). ## Args diff --git a/docs/scrython.cards/Named.md b/docs/scrython.cards/Named.md index 5aad21d..ad7c3cb 100644 --- a/docs/scrython.cards/Named.md +++ b/docs/scrython.cards/Named.md @@ -1,8 +1,8 @@ # **class** `scrython.cards.Named()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Named().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Named().scryfallJson`). ## Args diff --git a/docs/scrython.cards/Random.md b/docs/scrython.cards/Random.md index 7355200..c5a5373 100644 --- a/docs/scrython.cards/Random.md +++ b/docs/scrython.cards/Random.md @@ -1,8 +1,8 @@ # **class** `scrython.cards.Random()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Random().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Random().scryfallJson`). ## Args diff --git a/docs/scrython.cards/Search.md b/docs/scrython.cards/Search.md index 5fb5795..af3bd88 100644 --- a/docs/scrython.cards/Search.md +++ b/docs/scrython.cards/Search.md @@ -1,8 +1,8 @@ # **class** `scrython.cards.Search()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Search().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Search().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/ArtifactTypes.md b/docs/scrython.catalog/ArtifactTypes.md index 8b79391..06f780d 100644 --- a/docs/scrython.catalog/ArtifactTypes.md +++ b/docs/scrython.catalog/ArtifactTypes.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.ArtifactTypes()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ArtifactTypes().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ArtifactTypes().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/ArtistNames.md b/docs/scrython.catalog/ArtistNames.md index c1e1bb2..4ad1fcf 100644 --- a/docs/scrython.catalog/ArtistNames.md +++ b/docs/scrython.catalog/ArtistNames.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.ArtistNames()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ArtistNames().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ArtistNames().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/CardNames.md b/docs/scrython.catalog/CardNames.md index e7d65e8..44be35e 100644 --- a/docs/scrython.catalog/CardNames.md +++ b/docs/scrython.catalog/CardNames.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.CardNames()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`CardNames().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`CardNames().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/CreatureTypes.md b/docs/scrython.catalog/CreatureTypes.md index 475f494..e46283b 100644 --- a/docs/scrython.catalog/CreatureTypes.md +++ b/docs/scrython.catalog/CreatureTypes.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.CreatureTypes()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`CreatureTypes().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`CreatureTypes().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/EnchantmentTypes.md b/docs/scrython.catalog/EnchantmentTypes.md index 228c1b9..4688c21 100644 --- a/docs/scrython.catalog/EnchantmentTypes.md +++ b/docs/scrython.catalog/EnchantmentTypes.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.EnchantmentTypes()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`EnchantmentTypes().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`EnchantmentTypes().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/LandTypes.md b/docs/scrython.catalog/LandTypes.md index bd1ab11..900e70d 100644 --- a/docs/scrython.catalog/LandTypes.md +++ b/docs/scrython.catalog/LandTypes.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.LandTypes()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`LandTypes().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`LandTypes().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/Loyalties.md b/docs/scrython.catalog/Loyalties.md index 052c2de..af1d147 100644 --- a/docs/scrython.catalog/Loyalties.md +++ b/docs/scrython.catalog/Loyalties.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.Loyalties()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Loyalties().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Loyalties().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/PlaneswalkerTypes.md b/docs/scrython.catalog/PlaneswalkerTypes.md index e79cbf0..c40ffcc 100644 --- a/docs/scrython.catalog/PlaneswalkerTypes.md +++ b/docs/scrython.catalog/PlaneswalkerTypes.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.PlaneswalkerTypes()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`PlaneswalkerTypes().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`PlaneswalkerTypes().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/Powers.md b/docs/scrython.catalog/Powers.md index 83e22e1..0a2d086 100644 --- a/docs/scrython.catalog/Powers.md +++ b/docs/scrython.catalog/Powers.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.Powers()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Powers().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Powers().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/SpellTypes.md b/docs/scrython.catalog/SpellTypes.md index d42c615..671b18c 100644 --- a/docs/scrython.catalog/SpellTypes.md +++ b/docs/scrython.catalog/SpellTypes.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.SpellTypes()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`SpellTypes().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`SpellTypes().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/Toughnesses.md b/docs/scrython.catalog/Toughnesses.md index 339965b..af802cf 100644 --- a/docs/scrython.catalog/Toughnesses.md +++ b/docs/scrython.catalog/Toughnesses.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.Toughnesses()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Toughnesses().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Toughnesses().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/Watermarks.md b/docs/scrython.catalog/Watermarks.md index c60960b..f71c172 100644 --- a/docs/scrython.catalog/Watermarks.md +++ b/docs/scrython.catalog/Watermarks.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.Watermarks()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Watermarks().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Watermarks().scryfallJson`). ## Args diff --git a/docs/scrython.catalog/WordBank.md b/docs/scrython.catalog/WordBank.md index b990ee0..79a7be2 100644 --- a/docs/scrython.catalog/WordBank.md +++ b/docs/scrython.catalog/WordBank.md @@ -1,8 +1,8 @@ # **class** `scrython.catalog.WordBank()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`WordBank().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`WordBank().scryfallJson`). ## Args diff --git a/docs/scrython.rulings/Code.md b/docs/scrython.rulings/Code.md index 5524bef..e77df5a 100644 --- a/docs/scrython.rulings/Code.md +++ b/docs/scrython.rulings/Code.md @@ -1,8 +1,8 @@ # **class** `scrython.rulings.Code()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Code().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Code().scryfallJson`). ## Args diff --git a/docs/scrython.rulings/Id.md b/docs/scrython.rulings/Id.md index b2db086..396cf4d 100644 --- a/docs/scrython.rulings/Id.md +++ b/docs/scrython.rulings/Id.md @@ -1,8 +1,8 @@ # **class** `scrython.rulings.Id()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Id().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Id().scryfallJson`). ## Args diff --git a/docs/scrython.rulings/Mtgo.md b/docs/scrython.rulings/Mtgo.md index f17be7a..e28c15b 100644 --- a/docs/scrython.rulings/Mtgo.md +++ b/docs/scrython.rulings/Mtgo.md @@ -1,8 +1,8 @@ # **class** `scrython.rulings.Mtgo()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Mtgo().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Mtgo().scryfallJson`). ## Args diff --git a/docs/scrython.rulings/Multiverse.md b/docs/scrython.rulings/Multiverse.md index f83cd93..039324d 100644 --- a/docs/scrython.rulings/Multiverse.md +++ b/docs/scrython.rulings/Multiverse.md @@ -1,8 +1,8 @@ # **class** `scrython.rulings.Multiverse()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Multiverse().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Multiverse().scryfallJson`). ## Args diff --git a/docs/scrython.sets/Code.md b/docs/scrython.sets/Code.md index 969edee..5bcdff4 100644 --- a/docs/scrython.sets/Code.md +++ b/docs/scrython.sets/Code.md @@ -1,8 +1,8 @@ # **class** `scrython.sets.Code()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Code().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Code().scryfallJson`). ## Args diff --git a/docs/scrython.sets/Sets.md b/docs/scrython.sets/Sets.md index 57f3b6e..24b5a18 100644 --- a/docs/scrython.sets/Sets.md +++ b/docs/scrython.sets/Sets.md @@ -1,8 +1,8 @@ # **class** `scrython.sets.Sets()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Sets().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Sets().scryfallJson`). ## Args diff --git a/docs/scrython.symbology/ParseMana.md b/docs/scrython.symbology/ParseMana.md index 83a2d34..ffa26c7 100644 --- a/docs/scrython.symbology/ParseMana.md +++ b/docs/scrython.symbology/ParseMana.md @@ -1,8 +1,8 @@ # **class** `scrython.symbology.ParseMana()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ParseMana().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ParseMana().scryfallJson`). ## Args diff --git a/docs/scrython.symbology/Symbology.md b/docs/scrython.symbology/Symbology.md index 5c06a42..6bd26f7 100644 --- a/docs/scrython.symbology/Symbology.md +++ b/docs/scrython.symbology/Symbology.md @@ -1,8 +1,8 @@ # **class** `scrython.symbology.Symbology()` - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. +These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Symbology().scryfallJson`). +>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Symbology().scryfallJson`). ## Args diff --git a/gen_docs.py b/gen_docs.py deleted file mode 100644 index eaa31f2..0000000 --- a/gen_docs.py +++ /dev/null @@ -1,113 +0,0 @@ -import sys -import scrython -import re -from scrython.bulk_data import * -from scrython.cards import * -from scrython.catalog import * -from scrython.rulings import * -from scrython.sets import * -from scrython.symbology import * -from types import FunctionType - -def format_args(string, f): - f.write('\n## Args\n\n|arg|type|description|\n|:---:|:---:|:---:|\n') - - arg_list = re.findall(r'(\w*\s*\(\w+[,\s\w]{1,}\):[\w\s\'\\`,.]*[^\w\s\(])', string) - - for arg in arg_list: - arg_name = re.findall(r'[^\s]*', arg)[0] - - description = re.findall(r'(?<=:\s)(.*)', arg)[0] - - type_and_optional = re.findall(r'(?<=\()\w+[,\s\w]+(?=\))', arg)[0] - - if len(type_and_optional) > 1: - f.write('|{}|{}|{}|\n'.format(arg_name, type_and_optional, description)) - - else: - f.write('|{}|{}|{}|\n'.format(arg_name, type_and_optional, description)) - -def format_returns(string, f): - f.write('\n## Returns\n{}\n'.format(string.strip())) - -def format_raises(string, f): - - f.write('\n## Raises\n\n|exception type|reason|\n|:---:|:---:|\n') - - exception_list = re.findall(r'\w+:[\w\s\\\']+[^\s\w:]', string) - - for exception in exception_list: - exception_name = re.findall(r'[^:]*', exception)[0] - - exception_description = re.findall(r'(?<=:\s)([\w\s\.\'\\]*)', exception)[0] - - f.write('|{}|{}|\n'.format(exception_name, exception_description)) - -def format_examples(string, f): - - example_list = re.findall(r'>{3}[\s\w=.("+:,)]+', string) - - f.write('\n## Examples\n') - f.write('```python\n{}\n```\n'.format('\n'.join(example_list))) - -def format_functions(_class, function_list, f): - - f.write('\n## Methods\n') - - for function in function_list: - function_docstring = getattr(eval(_class), function).__doc__ - - f.write('\n---\n### `{}()`\n'.format(getattr(eval(_class), function).__name__)) - - f.write('\n```\n{}\n```'.format(function_docstring)) - -def main(subpackage): - for _class in subpackage.__all__: - - intro = """ - These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information. - - >In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`{}().scryfallJson`). - """.format(eval(_class).__name__) - - class_docstring = repr(re.sub(r'\n+', '', eval(_class).__doc__)) # removes newlines - - remove_extra_spaces = re.sub(' +', ' ', class_docstring) - - try: - args = re.findall(r'(?<=Args:)(.*)(?=Returns:)', remove_extra_spaces)[0] - - returns = re.findall(r'(?<=Returns:)(.*)(?=Raises:)', remove_extra_spaces)[0] - - raises = re.findall(r'(?<=Raises:)(.*)(?=Examples:)', remove_extra_spaces)[0] - - examples = re.findall(r'(?<=Examples:)(.*)', remove_extra_spaces)[0] - - functions = [x for x in dir(eval(_class)) if not x.startswith('_')] - - with open('./docs/{}/{}.md'.format(subpackage.__name__, _class), 'w') as f: - f.write('# **class** `{}.{}()`\n'.format(subpackage.__name__, _class)) - f.write(intro) - format_args(args, f) - format_returns(returns, f) - format_raises(raises, f) - format_examples(examples, f) - format_functions(_class, functions, f) - - except Exception as e: - print(_class.upper()) - print(repr(eval(_class).__doc__)) - print('Args: ', re.findall(r'(?<=Args:)(.*)(?=Returns:)', remove_extra_spaces)) - print('Returns: ', re.findall(r'(?<=Returns:)(.*)(?=Raises:)', remove_extra_spaces)) - print('Raises: ', re.findall(r'(?<=Raises:)(.*)(?=Examples:)', remove_extra_spaces)) - print('Examples: ', re.findall(r'(?<=Examples:)(.*)', remove_extra_spaces)) - print(e) - print('~~~~~~~~~~~~~~~~~~~~~~~~~~') - -if __name__ == '__main__': - main(scrython.bulk_data) - main(scrython.cards) - main(scrython.catalog) - main(scrython.rulings) - main(scrython.sets) - main(scrython.symbology) \ No newline at end of file