(docs) major reorganisation into subdirectories [skip ci]

danieljprice · Jan 31, 2024 · 363392a · 363392a
1 parent 8ecac17
commit 363392a
Show file tree

Hide file tree

Showing 71 changed files with 11 additions and 11 deletions.
diff --git a/docs/bots.rst → docs/developer-guide/bots.rst b/docs/bots.rst → docs/developer-guide/bots.rst
diff --git a/docs/data-curation.rst → docs/developer-guide/data-curation.rst b/docs/data-curation.rst → docs/developer-guide/data-curation.rst
diff --git a/docs/datafiles.rst → docs/developer-guide/datafiles.rst b/docs/datafiles.rst → docs/developer-guide/datafiles.rst
diff --git a/docs/fork.rst → docs/developer-guide/fork.rst b/docs/fork.rst → docs/developer-guide/fork.rst
diff --git a/docs/fortran.rst → docs/developer-guide/fortran.rst b/docs/fortran.rst → docs/developer-guide/fortran.rst
diff --git a/docs/developer-guide.rst → docs/developer-guide/index.rst b/docs/developer-guide.rst → docs/developer-guide/index.rst
diff --git a/docs/philosophy.rst → docs/developer-guide/philosophy.rst b/docs/philosophy.rst → docs/developer-guide/philosophy.rst
diff --git a/docs/sort.rst → docs/developer-guide/sort.rst b/docs/sort.rst → docs/developer-guide/sort.rst
diff --git a/docs/stable.rst → docs/developer-guide/stable.rst b/docs/stable.rst → docs/developer-guide/stable.rst
diff --git a/docs/staging.rst → docs/developer-guide/staging.rst b/docs/staging.rst → docs/developer-guide/staging.rst
diff --git a/docs/styleguide.rst → docs/developer-guide/styleguide.rst b/docs/styleguide.rst → docs/developer-guide/styleguide.rst
diff --git a/docs/testing.rst → docs/developer-guide/testing.rst b/docs/testing.rst → docs/developer-guide/testing.rst
diff --git a/docs/vscode.rst → docs/developer-guide/vscode.rst b/docs/vscode.rst → docs/developer-guide/vscode.rst
diff --git a/docs/CE.rst → docs/examples/CE.rst b/docs/CE.rst → docs/examples/CE.rst
diff --git a/docs/binary.rst → docs/examples/binary.rst b/docs/binary.rst → docs/examples/binary.rst
diff --git a/docs/density.rst → docs/examples/density.rst b/docs/density.rst → docs/examples/density.rst
diff --git a/docs/disc.rst → docs/examples/disc.rst b/docs/disc.rst → docs/examples/disc.rst
diff --git a/docs/dustgrowth.rst → docs/examples/dustgrowth.rst b/docs/dustgrowth.rst → docs/examples/dustgrowth.rst
diff --git a/docs/dustsettle.rst → docs/examples/dustsettle.rst b/docs/dustsettle.rst → docs/examples/dustsettle.rst
diff --git a/docs/hierarchicalsystems.rst → docs/examples/hierarchicalsystems.rst b/docs/hierarchicalsystems.rst → docs/examples/hierarchicalsystems.rst
diff --git a/docs/examples.rst → docs/examples/index.rst b/docs/examples.rst → docs/examples/index.rst
diff --git a/docs/mdot.rst → docs/examples/mdot.rst b/docs/mdot.rst → docs/examples/mdot.rst
diff --git a/docs/phantomNR.rst → docs/examples/phantomNR.rst b/docs/phantomNR.rst → docs/examples/phantomNR.rst
diff --git a/.../selfgravity_gravitationalinstability.rst → .../selfgravity_gravitationalinstability.rst b/.../selfgravity_gravitationalinstability.rst → .../selfgravity_gravitationalinstability.rst
diff --git a/docs/softstar.rst → docs/examples/softstar.rst b/docs/softstar.rst → docs/examples/softstar.rst
diff --git a/docs/star.rst → docs/examples/star.rst b/docs/star.rst → docs/examples/star.rst
diff --git a/docs/wind.rst → docs/examples/wind.rst b/docs/wind.rst → docs/examples/wind.rst
diff --git a/docs/fortree.rst → docs/external-utilities/fortree.rst b/docs/fortree.rst → docs/external-utilities/fortree.rst
diff --git a/docs/imorbel.rst → docs/external-utilities/imorbel.rst b/docs/imorbel.rst → docs/external-utilities/imorbel.rst
diff --git a/docs/external-utilities.rst → docs/external-utilities/index.rst b/docs/external-utilities.rst → docs/external-utilities/index.rst
diff --git a/docs/mcfost.rst → docs/external-utilities/mcfost.rst b/docs/mcfost.rst → docs/external-utilities/mcfost.rst
diff --git a/docs/phantom-config.rst → docs/external-utilities/phantom-config.rst b/docs/phantom-config.rst → docs/external-utilities/phantom-config.rst
diff --git a/docs/plonk.rst → docs/external-utilities/plonk.rst b/docs/plonk.rst → docs/external-utilities/plonk.rst
diff --git a/docs/sarracen.rst → docs/external-utilities/sarracen.rst b/docs/sarracen.rst → docs/external-utilities/sarracen.rst
diff --git a/docs/DiAL.rst → docs/getting-started/DiAL.rst b/docs/DiAL.rst → docs/getting-started/DiAL.rst
diff --git a/docs/clusters.rst → docs/getting-started/clusters.rst b/docs/clusters.rst → docs/getting-started/clusters.rst
diff --git a/docs/flatiron.rst → docs/getting-started/flatiron.rst b/docs/flatiron.rst → docs/getting-started/flatiron.rst
diff --git a/docs/g2.rst → docs/getting-started/g2.rst b/docs/g2.rst → docs/getting-started/g2.rst
diff --git a/docs/gitinfo.rst → docs/getting-started/gitinfo.rst b/docs/gitinfo.rst → docs/getting-started/gitinfo.rst
diff --git a/docs/getting-started.rst → docs/getting-started/index.rst b/docs/getting-started.rst → docs/getting-started/index.rst
diff --git a/docs/kennedy.rst → docs/getting-started/kennedy.rst b/docs/kennedy.rst → docs/getting-started/kennedy.rst
diff --git a/docs/monarch.rst → docs/getting-started/monarch.rst b/docs/monarch.rst → docs/getting-started/monarch.rst
diff --git a/docs/nci.rst → docs/getting-started/nci.rst b/docs/nci.rst → docs/getting-started/nci.rst
diff --git a/docs/ozstar.rst → docs/getting-started/ozstar.rst b/docs/ozstar.rst → docs/getting-started/ozstar.rst
diff --git a/docs/pawsey.rst → docs/getting-started/pawsey.rst b/docs/pawsey.rst → docs/getting-started/pawsey.rst
diff --git a/docs/running-clusters.rst → docs/getting-started/running-clusters.rst b/docs/running-clusters.rst → docs/getting-started/running-clusters.rst
diff --git a/docs/running-first-calculation.rst → ...ing-started/running-first-calculation.rst b/docs/running-first-calculation.rst → ...ing-started/running-first-calculation.rst
diff --git a/docs/running-mac.rst → docs/getting-started/running-mac.rst b/docs/running-mac.rst → docs/getting-started/running-mac.rst
diff --git a/docs/systems-list.rst → docs/getting-started/systems-list.rst b/docs/systems-list.rst → docs/getting-started/systems-list.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -20,12 +20,12 @@ Contents
 .. toctree::
    :maxdepth: 1
 
-   getting-started
-   user-guide
-   examples
-   external-utilities
-   physics-guide
-   developer-guide
+   getting-started/index
+   user-guide/index
+   examples/index
+   external-utilities/index
+   physics/index
+   developer-guide/index
    faq
    releasenotes
 

diff --git a/docs/eos-list.rst → docs/physics/eos-list.rst b/docs/eos-list.rst → docs/physics/eos-list.rst
diff --git a/docs/eos.rst → docs/physics/eos.rst b/docs/eos.rst → docs/physics/eos.rst
diff --git a/docs/physics-guide.rst → docs/physics/index.rst b/docs/physics-guide.rst → docs/physics/index.rst
diff --git a/docs/sink-properties.rst → docs/physics/sink-properties.rst b/docs/sink-properties.rst → docs/physics/sink-properties.rst
diff --git a/docs/sinks.rst → docs/physics/sinks.rst b/docs/sinks.rst → docs/physics/sinks.rst
diff --git a/docs/scripts/update_docs_from_code.sh b/docs/scripts/update_docs_from_code.sh
@@ -1,5 +1,5 @@
-./sink_particle_properties.pl > ../sink-properties.rst
-./eos_options.pl > ../eos-list.rst
-./print_setups.sh > ../setups-list.rst
-./print_setups.sh best > ../setups-best.rst
-./print_systems.sh > ../systems-list.rst
+./sink_particle_properties.pl > ../physics/sink-properties.rst
+./eos_options.pl > ../physics/eos-list.rst
+./print_setups.sh > ../user-guide/setups-list.rst
+./print_setups.sh best > ../user-guide/setups-best.rst
+./print_systems.sh > ../getting-started/systems-list.rst
diff --git a/docs/analysis.rst → docs/user-guide/analysis.rst b/docs/analysis.rst → docs/user-guide/analysis.rst
diff --git a/docs/config.rst → docs/user-guide/config.rst b/docs/config.rst → docs/user-guide/config.rst
diff --git a/docs/dumpfile.rst → docs/user-guide/dumpfile.rst b/docs/dumpfile.rst → docs/user-guide/dumpfile.rst
diff --git a/docs/hdf5.rst → docs/user-guide/hdf5.rst b/docs/hdf5.rst → docs/user-guide/hdf5.rst
diff --git a/docs/user-guide.rst → docs/user-guide/index.rst b/docs/user-guide.rst → docs/user-guide/index.rst
diff --git a/docs/infile.rst → docs/user-guide/infile.rst b/docs/infile.rst → docs/user-guide/infile.rst
diff --git a/docs/moddump.rst → docs/user-guide/moddump.rst b/docs/moddump.rst → docs/user-guide/moddump.rst
diff --git a/docs/mpi.rst → docs/user-guide/mpi.rst b/docs/mpi.rst → docs/user-guide/mpi.rst
diff --git a/docs/qscript.rst → docs/user-guide/qscript.rst b/docs/qscript.rst → docs/user-guide/qscript.rst
diff --git a/docs/setup.rst → docs/user-guide/setup.rst b/docs/setup.rst → docs/user-guide/setup.rst
diff --git a/docs/setups-best.rst → docs/user-guide/setups-best.rst b/docs/setups-best.rst → docs/user-guide/setups-best.rst
diff --git a/docs/setups-list.rst → docs/user-guide/setups-list.rst b/docs/setups-list.rst → docs/user-guide/setups-list.rst
diff --git a/docs/setups.rst → docs/user-guide/setups.rst b/docs/setups.rst → docs/user-guide/setups.rst
diff --git a/docs/sweeps.rst → docs/user-guide/sweeps.rst b/docs/sweeps.rst → docs/user-guide/sweeps.rst
diff --git a/docs/utils.rst → docs/user-guide/utils.rst b/docs/utils.rst → docs/user-guide/utils.rst