From dbcc8b4756d96b3ad621344ececc990aff7ba43d Mon Sep 17 00:00:00 2001
From: joncrall <jon.crall@kitware.com>
Date: Wed, 14 Aug 2024 18:58:30 -0400
Subject: [PATCH] Reorganize docs with new structure
---
docs/source/auto/modules.rst | 7 +++++++
.../scriptconfig._ubelt_repr_extension.rst | 0
.../{ => auto}/scriptconfig.argparse_ext.rst | 0
docs/source/{ => auto}/scriptconfig.cli.rst | 0
.../source/{ => auto}/scriptconfig.config.rst | 0
.../{ => auto}/scriptconfig.dataconfig.rst | 0
.../{ => auto}/scriptconfig.dict_like.rst | 0
.../{ => auto}/scriptconfig.file_like.rst | 0
docs/source/{ => auto}/scriptconfig.modal.rst | 0
docs/source/{ => auto}/scriptconfig.rst | 8 ++++++++
.../{ => auto}/scriptconfig.smartcast.rst | 0
docs/source/auto/scriptconfig.util.rst | 20 +++++++++++++++++++
.../auto/scriptconfig.util.util_class.rst | 8 ++++++++
.../auto/scriptconfig.util.util_exception.rst | 8 ++++++++
docs/source/{ => auto}/scriptconfig.value.rst | 0
docs/source/index.rst | 4 +++-
docs/source/{ => manual}/getting_started.rst | 0
17 files changed, 54 insertions(+), 1 deletion(-)
create mode 100644 docs/source/auto/modules.rst
rename docs/source/{ => auto}/scriptconfig._ubelt_repr_extension.rst (100%)
rename docs/source/{ => auto}/scriptconfig.argparse_ext.rst (100%)
rename docs/source/{ => auto}/scriptconfig.cli.rst (100%)
rename docs/source/{ => auto}/scriptconfig.config.rst (100%)
rename docs/source/{ => auto}/scriptconfig.dataconfig.rst (100%)
rename docs/source/{ => auto}/scriptconfig.dict_like.rst (100%)
rename docs/source/{ => auto}/scriptconfig.file_like.rst (100%)
rename docs/source/{ => auto}/scriptconfig.modal.rst (100%)
rename docs/source/{ => auto}/scriptconfig.rst (86%)
rename docs/source/{ => auto}/scriptconfig.smartcast.rst (100%)
create mode 100644 docs/source/auto/scriptconfig.util.rst
create mode 100644 docs/source/auto/scriptconfig.util.util_class.rst
create mode 100644 docs/source/auto/scriptconfig.util.util_exception.rst
rename docs/source/{ => auto}/scriptconfig.value.rst (100%)
rename docs/source/{ => manual}/getting_started.rst (100%)
diff --git a/docs/source/auto/modules.rst b/docs/source/auto/modules.rst
new file mode 100644
index 0000000..3cb7814
--- /dev/null
+++ b/docs/source/auto/modules.rst
@@ -0,0 +1,7 @@
+scriptconfig
+============
+
+.. toctree::
+ :maxdepth: 4
+
+ scriptconfig
diff --git a/docs/source/scriptconfig._ubelt_repr_extension.rst b/docs/source/auto/scriptconfig._ubelt_repr_extension.rst
similarity index 100%
rename from docs/source/scriptconfig._ubelt_repr_extension.rst
rename to docs/source/auto/scriptconfig._ubelt_repr_extension.rst
diff --git a/docs/source/scriptconfig.argparse_ext.rst b/docs/source/auto/scriptconfig.argparse_ext.rst
similarity index 100%
rename from docs/source/scriptconfig.argparse_ext.rst
rename to docs/source/auto/scriptconfig.argparse_ext.rst
diff --git a/docs/source/scriptconfig.cli.rst b/docs/source/auto/scriptconfig.cli.rst
similarity index 100%
rename from docs/source/scriptconfig.cli.rst
rename to docs/source/auto/scriptconfig.cli.rst
diff --git a/docs/source/scriptconfig.config.rst b/docs/source/auto/scriptconfig.config.rst
similarity index 100%
rename from docs/source/scriptconfig.config.rst
rename to docs/source/auto/scriptconfig.config.rst
diff --git a/docs/source/scriptconfig.dataconfig.rst b/docs/source/auto/scriptconfig.dataconfig.rst
similarity index 100%
rename from docs/source/scriptconfig.dataconfig.rst
rename to docs/source/auto/scriptconfig.dataconfig.rst
diff --git a/docs/source/scriptconfig.dict_like.rst b/docs/source/auto/scriptconfig.dict_like.rst
similarity index 100%
rename from docs/source/scriptconfig.dict_like.rst
rename to docs/source/auto/scriptconfig.dict_like.rst
diff --git a/docs/source/scriptconfig.file_like.rst b/docs/source/auto/scriptconfig.file_like.rst
similarity index 100%
rename from docs/source/scriptconfig.file_like.rst
rename to docs/source/auto/scriptconfig.file_like.rst
diff --git a/docs/source/scriptconfig.modal.rst b/docs/source/auto/scriptconfig.modal.rst
similarity index 100%
rename from docs/source/scriptconfig.modal.rst
rename to docs/source/auto/scriptconfig.modal.rst
diff --git a/docs/source/scriptconfig.rst b/docs/source/auto/scriptconfig.rst
similarity index 86%
rename from docs/source/scriptconfig.rst
rename to docs/source/auto/scriptconfig.rst
index d02ed9b..ffc2818 100644
--- a/docs/source/scriptconfig.rst
+++ b/docs/source/auto/scriptconfig.rst
@@ -1,6 +1,14 @@
scriptconfig package
====================
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ scriptconfig.util
+
Submodules
----------
diff --git a/docs/source/scriptconfig.smartcast.rst b/docs/source/auto/scriptconfig.smartcast.rst
similarity index 100%
rename from docs/source/scriptconfig.smartcast.rst
rename to docs/source/auto/scriptconfig.smartcast.rst
diff --git a/docs/source/auto/scriptconfig.util.rst b/docs/source/auto/scriptconfig.util.rst
new file mode 100644
index 0000000..10da1d3
--- /dev/null
+++ b/docs/source/auto/scriptconfig.util.rst
@@ -0,0 +1,20 @@
+scriptconfig.util package
+=========================
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ scriptconfig.util.util_class
+ scriptconfig.util.util_exception
+
+Module contents
+---------------
+
+.. automodule:: scriptconfig.util
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :private-members:
diff --git a/docs/source/auto/scriptconfig.util.util_class.rst b/docs/source/auto/scriptconfig.util.util_class.rst
new file mode 100644
index 0000000..ba94adc
--- /dev/null
+++ b/docs/source/auto/scriptconfig.util.util_class.rst
@@ -0,0 +1,8 @@
+scriptconfig.util.util\_class module
+====================================
+
+.. automodule:: scriptconfig.util.util_class
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :private-members:
diff --git a/docs/source/auto/scriptconfig.util.util_exception.rst b/docs/source/auto/scriptconfig.util.util_exception.rst
new file mode 100644
index 0000000..4a38027
--- /dev/null
+++ b/docs/source/auto/scriptconfig.util.util_exception.rst
@@ -0,0 +1,8 @@
+scriptconfig.util.util\_exception module
+========================================
+
+.. automodule:: scriptconfig.util.util_exception
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :private-members:
diff --git a/docs/source/scriptconfig.value.rst b/docs/source/auto/scriptconfig.value.rst
similarity index 100%
rename from docs/source/scriptconfig.value.rst
rename to docs/source/auto/scriptconfig.value.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 3cc38dc..8dc6a17 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -15,7 +15,9 @@ ScriptConfig's documentation
:maxdepth: 8
:caption: Package Layout
- modules
+ auto/scriptconfig
+ auto/modules
+ manual/getting_started
Indices and tables
diff --git a/docs/source/getting_started.rst b/docs/source/manual/getting_started.rst
similarity index 100%
rename from docs/source/getting_started.rst
rename to docs/source/manual/getting_started.rst
--
GitLab