From 964065c29bd937475cc1bf7d5969e167560b8456 Mon Sep 17 00:00:00 2001 From: JumiDeluxe <47438768+JumiDeluxe@users.noreply.github.com> Date: Thu, 23 Nov 2023 00:46:45 +0100 Subject: [PATCH] Transaction graph and docs cleanup (#521) --- docs/Current_graph.md | 5 ----- docs/{Assumptions.md => assumptions.md} | 0 docs/current-graph.md | 12 ++++++++++ ...ironment.md => development-environment.md} | 0 docs/{Home.md => home.md} | 0 docs/index.md | 22 +++++++++---------- ...ptionsSummary.md => exceptions-summary.md} | 0 ...blem-checklist.md => problem-checklist.md} | 0 docs/scheduler/{Overview.md => overview.md} | 0 .../implementation/rs-impl.md} | 0 .../RS.md => shared-structs/rs.md} | 0 docs/synthesis/{Synthesis.md => synthesis.md} | 0 docs/{Transactions.md => transactions.md} | 0 13 files changed, 23 insertions(+), 16 deletions(-) delete mode 100644 docs/Current_graph.md rename docs/{Assumptions.md => assumptions.md} (100%) create mode 100644 docs/current-graph.md rename docs/{Development_environment.md => development-environment.md} (100%) rename docs/{Home.md => home.md} (100%) rename docs/miscellany/{exceptionsSummary.md => exceptions-summary.md} (100%) rename docs/{Problem-checklist.md => problem-checklist.md} (100%) rename docs/scheduler/{Overview.md => overview.md} (100%) rename docs/{shared_structs/Implementation/RS_impl.md => shared-structs/implementation/rs-impl.md} (100%) rename docs/{shared_structs/RS.md => shared-structs/rs.md} (100%) rename docs/synthesis/{Synthesis.md => synthesis.md} (100%) rename docs/{Transactions.md => transactions.md} (100%) diff --git a/docs/Current_graph.md b/docs/Current_graph.md deleted file mode 100644 index 1d64977b4..000000000 --- a/docs/Current_graph.md +++ /dev/null @@ -1,5 +0,0 @@ -# Full transaction-method graph - -```{eval-rst} -.. include:: auto_graph.rst -``` diff --git a/docs/Assumptions.md b/docs/assumptions.md similarity index 100% rename from docs/Assumptions.md rename to docs/assumptions.md diff --git a/docs/current-graph.md b/docs/current-graph.md new file mode 100644 index 000000000..c176682f2 --- /dev/null +++ b/docs/current-graph.md @@ -0,0 +1,12 @@ +# Full transaction-method graph + +
+
+ + ```{eval-rst} + .. include:: auto_graph.rst + + ``` + +
+
diff --git a/docs/Development_environment.md b/docs/development-environment.md similarity index 100% rename from docs/Development_environment.md rename to docs/development-environment.md diff --git a/docs/Home.md b/docs/home.md similarity index 100% rename from docs/Home.md rename to docs/home.md diff --git a/docs/index.md b/docs/index.md index 85d7b3e2c..0e16a25ec 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,17 +5,17 @@ maxdepth: 3 --- -Home.md -Assumptions.md -Development_environment.md -Transactions.md -scheduler/Overview.md -shared_structs/Implementation/RS_impl.md -shared_structs/RS.md -Current_graph.md -Problem-checklist.md -synthesis/Synthesis.md +home.md +assumptions.md +development-environment.md +transactions.md +scheduler/overview.md +shared-structs/implementation/rs-impl.md +shared-structs/rs.md +current-graph.md +problem-checklist.md +synthesis/synthesis.md components/icache.md -miscellany/exceptionsSummary.md +miscellany/exceptions-summary.md api.md ``` diff --git a/docs/miscellany/exceptionsSummary.md b/docs/miscellany/exceptions-summary.md similarity index 100% rename from docs/miscellany/exceptionsSummary.md rename to docs/miscellany/exceptions-summary.md diff --git a/docs/Problem-checklist.md b/docs/problem-checklist.md similarity index 100% rename from docs/Problem-checklist.md rename to docs/problem-checklist.md diff --git a/docs/scheduler/Overview.md b/docs/scheduler/overview.md similarity index 100% rename from docs/scheduler/Overview.md rename to docs/scheduler/overview.md diff --git a/docs/shared_structs/Implementation/RS_impl.md b/docs/shared-structs/implementation/rs-impl.md similarity index 100% rename from docs/shared_structs/Implementation/RS_impl.md rename to docs/shared-structs/implementation/rs-impl.md diff --git a/docs/shared_structs/RS.md b/docs/shared-structs/rs.md similarity index 100% rename from docs/shared_structs/RS.md rename to docs/shared-structs/rs.md diff --git a/docs/synthesis/Synthesis.md b/docs/synthesis/synthesis.md similarity index 100% rename from docs/synthesis/Synthesis.md rename to docs/synthesis/synthesis.md diff --git a/docs/Transactions.md b/docs/transactions.md similarity index 100% rename from docs/Transactions.md rename to docs/transactions.md