diff --git a/docs/source/auto/modules.rst b/docs/source/auto/modules.rst new file mode 100644 index 0000000000000000000000000000000000000000..3cb7814e9ac1c0693c45e817d2d9bc07ccc18246 --- /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 d02ed9bb8ccd0097d4cffe46684b5a8bf261ca1d..ffc281834107c5d22129c0844a09067613fc8893 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 0000000000000000000000000000000000000000..10da1d3fb458dc313a1098729b7f7cf9e5c9be0c --- /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 0000000000000000000000000000000000000000..ba94adc240801772fda9a86c7f9fb12303eacbcc --- /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 0000000000000000000000000000000000000000..4a380276cfc09ce5faef3d1ca9c5379a4379fc11 --- /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 3cc38dce9dfb338982abcf8be58ae570291fb7a0..8dc6a17108f2e8afe9dc495bf5eb4fea4c42b6a2 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