From 836fd3c43e06115bc80cb097d78d635a667a349e Mon Sep 17 00:00:00 2001 From: Kent Pitman Date: Sat, 12 Aug 2023 18:43:19 -0400 Subject: [PATCH] Opportunistic: Adjust the way some sections and subsections are presented to make things a bit more aesthetic. --- docs/source/submitr.rst | 23 +++++++++++------------ docs/source/submitr.scripts.rst | 11 ++++------- docs/source/submitr.tests.rst | 19 ++++++++----------- 3 files changed, 23 insertions(+), 30 deletions(-) diff --git a/docs/source/submitr.rst b/docs/source/submitr.rst index 4e02965..4648e6a 100644 --- a/docs/source/submitr.rst +++ b/docs/source/submitr.rst @@ -1,18 +1,6 @@ submitr package =============== -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - submitr.scripts - submitr.tests - -Submodules ----------- - submitr.base module ------------------- @@ -44,3 +32,14 @@ submitr.utils module :members: :undoc-members: :show-inheritance: + +------------------------- + +submitr subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + submitr.scripts + submitr.tests diff --git a/docs/source/submitr.scripts.rst b/docs/source/submitr.scripts.rst index 53dd56a..75a2508 100644 --- a/docs/source/submitr.scripts.rst +++ b/docs/source/submitr.scripts.rst @@ -1,11 +1,8 @@ submitr.scripts package ============================ -Submodules ----------- - submitr.scripts.make\_sample\_fastq\_file module ------------------------------------------------------ +------------------------------------------------ .. automodule:: submitr.scripts.make_sample_fastq_file :members: @@ -13,7 +10,7 @@ submitr.scripts.make\_sample\_fastq\_file module :show-inheritance: submitr.scripts.resume\_uploads module -------------------------------------------- +-------------------------------------- .. automodule:: submitr.scripts.resume_uploads :members: @@ -21,7 +18,7 @@ submitr.scripts.resume\_uploads module :show-inheritance: submitr.scripts.submit\_metadata\_bundle module ----------------------------------------------------- +----------------------------------------------- .. automodule:: submitr.scripts.submit_metadata_bundle :members: @@ -29,7 +26,7 @@ submitr.scripts.submit\_metadata\_bundle module :show-inheritance: submitr.scripts.upload\_item\_data module ----------------------------------------------- +----------------------------------------- .. automodule:: submitr.scripts.upload_item_data :members: diff --git a/docs/source/submitr.tests.rst b/docs/source/submitr.tests.rst index 113eb47..1d4b843 100644 --- a/docs/source/submitr.tests.rst +++ b/docs/source/submitr.tests.rst @@ -1,11 +1,8 @@ submitr.tests package ========================== -Submodules ----------- - submitr.tests.test\_base module ------------------------------------- +------------------------------- .. automodule:: submitr.tests.test_base :members: @@ -13,7 +10,7 @@ submitr.tests.test\_base module :show-inheritance: submitr.tests.test\_exceptions module ------------------------------------------- +------------------------------------- .. automodule:: submitr.tests.test_exceptions :members: @@ -21,7 +18,7 @@ submitr.tests.test\_exceptions module :show-inheritance: submitr.tests.test\_make\_sample\_fastq\_file module ---------------------------------------------------------- +---------------------------------------------------- .. automodule:: submitr.tests.test_make_sample_fastq_file :members: @@ -29,7 +26,7 @@ submitr.tests.test\_make\_sample\_fastq\_file module :show-inheritance: submitr.tests.test\_resume\_uploads module ------------------------------------------------ +------------------------------------------ .. automodule:: submitr.tests.test_resume_uploads :members: @@ -37,7 +34,7 @@ submitr.tests.test\_resume\_uploads module :show-inheritance: submitr.tests.test\_submission module ------------------------------------------- +------------------------------------- .. automodule:: submitr.tests.test_submission :members: @@ -45,7 +42,7 @@ submitr.tests.test\_submission module :show-inheritance: submitr.tests.test\_submit\_metadata\_bundle module --------------------------------------------------------- +--------------------------------------------------- .. automodule:: submitr.tests.test_submit_metadata_bundle :members: @@ -53,7 +50,7 @@ submitr.tests.test\_submit\_metadata\_bundle module :show-inheritance: submitr.tests.test\_upload\_item\_data module --------------------------------------------------- +--------------------------------------------- .. automodule:: submitr.tests.test_upload_item_data :members: @@ -61,7 +58,7 @@ submitr.tests.test\_upload\_item\_data module :show-inheritance: submitr.tests.test\_utils module -------------------------------------- +-------------------------------- .. automodule:: submitr.tests.test_utils :members: