From ec5cebfeefca6fa6953b277db1a7220c67b5b5f4 Mon Sep 17 00:00:00 2001 From: silviana amethyst <1388063+ofloveandhate@users.noreply.github.com> Date: Wed, 24 Jul 2024 13:23:20 -0500 Subject: [PATCH] more clear headings, a slight re-structure --- docs/emoji.rst | 2 +- docs/gotchas.rst | 4 ++-- docs/index.rst | 32 +++++++++++++++++++++----------- docs/on_meta_dot_json.rst | 6 +----- 4 files changed, 25 insertions(+), 19 deletions(-) diff --git a/docs/emoji.rst b/docs/emoji.rst index 93f626e..390173a 100644 --- a/docs/emoji.rst +++ b/docs/emoji.rst @@ -1,4 +1,4 @@ -Emojification +🙂 Emojification ================== diff --git a/docs/gotchas.rst b/docs/gotchas.rst index 0afc1f5..4a15026 100644 --- a/docs/gotchas.rst +++ b/docs/gotchas.rst @@ -1,5 +1,5 @@ -Gotchas -========== +💥 Gotchas +=========== There are some idiosyncrasies in `markdown2canvas`. This page is me doing my best to share them with you. diff --git a/docs/index.rst b/docs/index.rst index 6e3297c..d60be44 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,7 +12,7 @@ This is the documentation for `markdown2canvas`, a Python library for containeri :maxdepth: 2 :caption: Contents: -Tutorials +Tutorials 👩‍🏫 ================ .. toctree:: @@ -30,13 +30,11 @@ Tutorials -.. _Top_Notes: - -Notes -======== +Usage notes +================================= .. toctree:: - :maxdepth: 1 + :maxdepth: 2 :caption: Some useful notes on aspects of using the library gotchas @@ -44,20 +42,32 @@ Notes on_meta_dot_json markdown_1 making_links_to_existing_content - wishlist - unit_tests - history -Useful links -============== + + + +Useful links 🔗 +================ * `Canvas API documentation at root level `_ * `Canvas API class documentation `_ I use this when chasing down how to set additional properties for various content types. +Implementation notes +======================= + +.. toctree:: + :maxdepth: 1 + :caption: Notes about library implementation + + wishlist + unit_tests + history + + Details 📝 ================ diff --git a/docs/on_meta_dot_json.rst b/docs/on_meta_dot_json.rst index 91b910f..7850ed6 100644 --- a/docs/on_meta_dot_json.rst +++ b/docs/on_meta_dot_json.rst @@ -6,10 +6,6 @@ The `meta.json` file must be present in every containerized content folder. -Valid properties ------------------ - - meta.json for ALL content types ********************************* @@ -130,7 +126,7 @@ Optional: What happens if I specify a property / key that's not used or is invalid? ------------------------------------------------------------------------------ +***************************************************************************** * Extra keys are ignored with no message. * Missing required keys hopefully WILL generate a problem!!!