diff --git a/docs/source/conf.py b/docs/source/conf.py index cbe4e44d..4462b4bb 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,5 +1,5 @@ # Configuration file for the Sphinx documentation builder. - +import os # -- Project information project = 'kaiju' @@ -47,3 +47,17 @@ html_theme_options = { html_css_files = [ 'css/sidebar_theme.css', ] + +exclude_patterns = [ + "_build", + "Thumbs.db", + ".DS_Store", +] + +if not os.environ.get("BUILD_ALL"): + exclude_patterns.append("misc/**") + +def setup(app): + + if os.environ.get('BUILD_ALL'): + app.tags.add('misc') \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 7e9929d0..237215c9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -33,3 +33,13 @@ Table of contents makeitso/index tools/index roadrules + +.. only:: misc + + Internal Docs + ------------- + + .. toctree:: + :maxdepth: 2 + + misc/index \ No newline at end of file diff --git a/docs/source/misc/_obsolete/chimp/calcdb.x.rst b/docs/source/misc/_obsolete/chimp/calcdb.x.rst deleted file mode 100644 index 1eb53f89..00000000 --- a/docs/source/misc/_obsolete/chimp/calcdb.x.rst +++ /dev/null @@ -1,4 +0,0 @@ -Computing Ground Magnetic Field Perturbations (calcdb.x) -======================================================== - -TBD diff --git a/docs/source/misc/_obsolete/chimpQuickStart.rst b/docs/source/misc/_obsolete/chimp/chimpQuickStart.rst similarity index 98% rename from docs/source/misc/_obsolete/chimpQuickStart.rst rename to docs/source/misc/_obsolete/chimp/chimpQuickStart.rst index 372a68dd..b6d87380 100644 --- a/docs/source/misc/_obsolete/chimpQuickStart.rst +++ b/docs/source/misc/_obsolete/chimp/chimpQuickStart.rst @@ -52,7 +52,7 @@ the start time of the simulation being used for the calculation. ``tFin`` is the stop time the test particle trajectories, in seconds from the start time of the simulation being used for the calculation. -For other parameters see the :doc:`Chimp XML ` page. +For other parameters see the :doc:`Chimp XML ` page. Create the PBS file ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/misc/_obsolete/chimp/chop.x.rst b/docs/source/misc/_obsolete/chimp/chop.x.rst deleted file mode 100644 index ea73ada8..00000000 --- a/docs/source/misc/_obsolete/chimp/chop.x.rst +++ /dev/null @@ -1,234 +0,0 @@ -Extract a 3D subdomain from GAMERA output (chop.x) -================================================== - -Introduction ------------- - -chop.x extracts a 3D portion of the domain from GAMERA output on either the -MAGE grid or interpolated onto a cartesian or a spherical grid and perform -additional calculations such as field line tracing. Output is to an hdf5 file -that can be visualized and analyzed similarly to GAMERA output files. - -Example XML file ----------------- - -.. code-block:: - - - - - - - - -Parameter Descriptions ----------------------- - - -```` (optional): Specify identifying information for this computation. - -``runid`` (optional, default ``"Sim"``): String specifying an identifier -for this run of ``chop.x``. A best practice is to use the ``runid`` in the -name of the XML file. - -``