Removing outdated documentation and creating developer tools section (#…

…2095) * removing outdated documentation * Revert "removing outdated documentation" This reverts commit 374a3c3. * removing outdated docs * moving profiling page
tardis-sn · Sep 12, 2022 · 782365c · 782365c
1 parent 5ad1cb3
commit 782365c
Show file tree

Hide file tree

Showing 20 changed files with 22 additions and 3,779 deletions.
diff --git a/docs/contributing/development/index.rst b/docs/contributing/development/index.rst
@@ -32,4 +32,3 @@ the core team (active maintainers) of TARDIS.
     update_refdata
     matterbridge
     debug_numba
-    profiling/index
diff --git a/docs/outdated/hdf_writer.ipynb → docs/contributing/tools/hdf_writer.ipynb b/docs/outdated/hdf_writer.ipynb → docs/contributing/tools/hdf_writer.ipynb
@@ -1,16 +1,10 @@
 {
  "cells": [
   {
-   "cell_type": "raw",
-   "metadata": {
-    "raw_mimetype": "text/restructuredtext"
-   },
+   "cell_type": "markdown",
+   "metadata": {},
    "source": [
-    ".. _hdf_writer:\n",
-    "\n",
-    "**************************\n",
-    "Example Usage of HDFWriter\n",
-    "**************************"
+    "# Example Usage of HDFWriter"
    ]
   },
   {
@@ -255,7 +249,7 @@
  "metadata": {
   "celltoolbar": "Raw Cell Format",
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3.8.13 ('tardis')",
    "language": "python",
    "name": "python3"
   },
@@ -269,7 +263,12 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.10"
+   "version": "3.8.13"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "c20eb03b6e6c860a5223c79131a5cfd0b7e61a9aa5d08c2b1400663bc6cc4e6d"
+   }
   }
  },
  "nbformat": 4,

diff --git a/docs/contributing/tools/index.rst b/docs/contributing/tools/index.rst
@@ -0,0 +1,11 @@
+***************
+Developer Tools
+***************
+
+The following pages contain information about coding concepts used in the development of TARDIS:
+
+.. toctree::
+
+    hdf_writer
+    isotope_pd_subclass
+    profiling/index
diff --git a/docs/outdated/isotope_pd_subclass.ipynb → ...tributing/tools/isotope_pd_subclass.ipynb b/docs/outdated/isotope_pd_subclass.ipynb → ...tributing/tools/isotope_pd_subclass.ipynb
diff --git a/...g/cpu_threads_dict_128_threads_1_node.csv → ...g/cpu_threads_dict_128_threads_1_node.csv b/...g/cpu_threads_dict_128_threads_1_node.csv → ...g/cpu_threads_dict_128_threads_1_node.csv
diff --git a/...tributing/development/profiling/index.rst → docs/contributing/tools/profiling/index.rst b/...tributing/development/profiling/index.rst → docs/contributing/tools/profiling/index.rst
diff --git a/...lopment/profiling/profiling_example.ipynb → ...g/tools/profiling/profiling_example.ipynb b/...lopment/profiling/profiling_example.ipynb → ...g/tools/profiling/profiling_example.ipynb
diff --git a/.../development/profiling/tardis_example.yml → ...buting/tools/profiling/tardis_example.yml b/.../development/profiling/tardis_example.yml → ...buting/tools/profiling/tardis_example.yml
diff --git a/...ing/development/profiling/tardis_prof.png → ...tributing/tools/profiling/tardis_prof.png b/...ing/development/profiling/tardis_prof.png → ...tributing/tools/profiling/tardis_prof.png
diff --git a/.../profiling/tardis_profiling_threads.ipynb → .../profiling/tardis_profiling_threads.ipynb b/.../profiling/tardis_profiling_threads.ipynb → .../profiling/tardis_profiling_threads.ipynb
diff --git a/...iling/threads_dict_128_threads_1_node.csv → ...iling/threads_dict_128_threads_1_node.csv b/...iling/threads_dict_128_threads_1_node.csv → ...iling/threads_dict_128_threads_1_node.csv
diff --git a/docs/index.rst b/docs/index.rst
@@ -88,6 +88,7 @@ Mission Statement
 
     contributing/CONTRIBUTING.md
     contributing/development/index
+    contributing/tools/index
     contributing/CHANGELOG.md
     contributing/in_progress/index
 
@@ -100,11 +101,3 @@ Mission Statement
     resources/research_done_using_TARDIS/research_papers
     resources/code_comparison/index
     resources/zreferences
-
-
-.. toctree::
-    :maxdepth: 2
-    :caption: Outdated
-    :hidden:
-
-    outdated/index
diff --git a/docs/outdated/commandline.rst b/docs/outdated/commandline.rst
diff --git a/docs/outdated/index.rst b/docs/outdated/index.rst
diff --git a/docs/outdated/init_trad_bug.ipynb b/docs/outdated/init_trad_bug.ipynb