Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removing outdated documentation and creating developer tools section #2095

Merged
merged 4 commits into from
Sep 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/contributing/development/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ the core team (active maintainers) of TARDIS.
update_refdata
matterbridge
debug_numba
profiling/index
Original file line number Diff line number Diff line change
@@ -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"
]
},
{
Expand Down Expand Up @@ -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"
},
Expand All @@ -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,
Expand Down
11 changes: 11 additions & 0 deletions docs/contributing/tools/index.rst
Original file line number Diff line number Diff line change
@@ -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
9 changes: 1 addition & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ Mission Statement

contributing/CONTRIBUTING.md
contributing/development/index
contributing/tools/index
contributing/CHANGELOG.md
contributing/in_progress/index

Expand All @@ -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
34 changes: 0 additions & 34 deletions docs/outdated/commandline.rst

This file was deleted.

26 changes: 0 additions & 26 deletions docs/outdated/index.rst

This file was deleted.

1,710 changes: 0 additions & 1,710 deletions docs/outdated/init_trad_bug.ipynb

This file was deleted.

Loading