From d9443d35639b7c3b76e58fb85ba7ae6454064410 Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Wed, 27 Nov 2024 10:23:20 +0100 Subject: [PATCH 1/3] Add files to be ignored --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 68bc17f..5b7720a 100644 --- a/.gitignore +++ b/.gitignore @@ -158,3 +158,6 @@ cython_debug/ # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ +poetry.lock +*/README_preprocessed.md +test.ipynb \ No newline at end of file From c5b4b66f6e907b239a6421e3cb72aa999ad8041f Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Wed, 27 Nov 2024 10:23:30 +0100 Subject: [PATCH 2/3] Setup basic rtd page --- docs/source/api.rst | 33 +++++++++++++++++++++++++++++++++ docs/source/conf.py | 11 +++++++---- docs/source/index.rst | 20 +++++--------------- docs/source/readme.rst | 6 ------ 4 files changed, 45 insertions(+), 25 deletions(-) create mode 100644 docs/source/api.rst delete mode 100644 docs/source/readme.rst diff --git a/docs/source/api.rst b/docs/source/api.rst new file mode 100644 index 0000000..d63bd90 --- /dev/null +++ b/docs/source/api.rst @@ -0,0 +1,33 @@ +API Reference +============ + +Model +---- +.. automodule:: deep_quality_estimation.model + :members: + :undoc-members: + :show-inheritance: + +Data Handling +------------ +.. automodule:: deep_quality_estimation.data_handler + :members: + :undoc-members: + :show-inheritance: + +.. automodule:: deep_quality_estimation.transforms + :members: + :undoc-members: + :show-inheritance: + +Utilities +--------- +.. automodule:: deep_quality_estimation.center_of_mass + :members: + :undoc-members: + :show-inheritance: + +.. automodule:: deep_quality_estimation.enums + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index d76ebed..e0d57eb 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -8,7 +8,7 @@ from subprocess import run -sys.path.insert(0, os.path.abspath("../../")) +sys.path.insert(0, os.path.abspath("../..")) run(["python", "preprocess_readme.py"]) @@ -16,7 +16,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = "PACKAGE_NAME" +project = "Deep Quality Estimation" copyright = "2024, Marcel Rosier et al." author = "Marcel Rosier, Florian Kofler" @@ -38,9 +38,12 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "pydata-sphinx-theme" +html_theme = "pydata_sphinx_theme" +html_theme_options = { + "github_url": "https://github.com/BrainLesion/deep_quality_estimation", +} # html_static_path = ["_static"] - +autodoc_mock_imports = ['torch', 'monai'] # Mock imports to avoid dependency issues autodoc_default_options = { "members": True, "undoc-members": True, diff --git a/docs/source/index.rst b/docs/source/index.rst index ee56e5b..026224b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,22 +1,12 @@ -PACKAGE_NAME documentation -=================== +deep_quality_estimation +========================= .. include:: ../README_preprocessed.md :parser: myst_parser.sphinx_ - -Sections -=================== - - - -.. toctree:: - :maxdepth: 1 - :caption: Getting Started: - - readme - .. toctree:: :maxdepth: 2 - :caption: API Reference: + :hidden: + :caption: API Reference + api \ No newline at end of file diff --git a/docs/source/readme.rst b/docs/source/readme.rst deleted file mode 100644 index bf35448..0000000 --- a/docs/source/readme.rst +++ /dev/null @@ -1,6 +0,0 @@ -Readme -============== - - -.. include:: ../README_preprocessed.md - :parser: myst_parser.sphinx_ \ No newline at end of file From 80201394ef645fd528fe103b73a85ba281b7a1a8 Mon Sep 17 00:00:00 2001 From: "brainless-bot[bot]" <153751247+brainless-bot[bot]@users.noreply.github.com> Date: Wed, 27 Nov 2024 09:26:00 +0000 Subject: [PATCH 3/3] Autoformat with black --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index e0d57eb..c9b534a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,7 +43,7 @@ "github_url": "https://github.com/BrainLesion/deep_quality_estimation", } # html_static_path = ["_static"] -autodoc_mock_imports = ['torch', 'monai'] # Mock imports to avoid dependency issues +autodoc_mock_imports = ["torch", "monai"] # Mock imports to avoid dependency issues autodoc_default_options = { "members": True, "undoc-members": True,