diff --git a/docs/code_reference/cal_tools.md b/docs/code_reference/cal_tools.md deleted file mode 100644 index 0806f0c400776dbc6a3808ca570a4c1bcd02616d..0000000000000000000000000000000000000000 --- a/docs/code_reference/cal_tools.md +++ /dev/null @@ -1,7 +0,0 @@ -# Calibration tools - -::: cal_tools.gotthard2.gotthard2lib - -::: cal_tools.epix100.epix100lib - -::: cal_tools.tools \ No newline at end of file diff --git a/docs/code_reference/calcat_interface.md b/docs/code_reference/calcat_interface.md deleted file mode 100644 index 30794269b0e68f0f465112aaa04bbd1b5adeee0f..0000000000000000000000000000000000000000 --- a/docs/code_reference/calcat_interface.md +++ /dev/null @@ -1,8 +0,0 @@ -# CalCAT Interface - - -??? Note "This module help in skipping calibrationDBRemote" -  - - -::: cal_tools.calcat_interface \ No newline at end of file diff --git a/docs/gen_ref_pages.py b/docs/gen_ref_pages.py index cf32dc1673108299ffe1cdbaaa87c7975494d226..754d74cf4d427fb82372427731224472ef72e0c8 100644 --- a/docs/gen_ref_pages.py +++ b/docs/gen_ref_pages.py @@ -7,7 +7,8 @@ import mkdocs_gen_files nav = mkdocs_gen_files.Nav() -for path in sorted(Path("src").rglob("*.py")): +for path in sorted(Path("src").rglob("*.py")): + module_path = path.relative_to("src").with_suffix("") doc_path = path.relative_to("src").with_suffix(".md") @@ -19,7 +20,7 @@ for path in sorted(Path("src").rglob("*.py")): if parts[-1] == "__init__": parts = parts[:-1] print("init parts:", parts) - if parts[-1] in ["notebooks", "settings", "calcat_interface", "restful_config", "__main__"]: + if parts[-1] in ["notebooks", "settings", "restful_config", "__main__"]: continue nav[parts] = doc_path.as_posix() @@ -27,9 +28,16 @@ for path in sorted(Path("src").rglob("*.py")): with mkdocs_gen_files.open(full_doc_path, "w") as fd: identifier = ".".join(parts) - print("::: " + identifier, file=fd) + if "calcat_interface" == full_doc_path.stem: + print( +""" +??? Note "This module help in skipping calibrationDBRemote" +  +""", + file=fd) + print("::: " + "src." + identifier, file=fd) mkdocs_gen_files.set_edit_path(full_doc_path, path) -with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file: - nav_file.writelines(nav.build_literate_nav()) +with mkdocs_gen_files.open(f"reference/summary.md", "w") as nav_file: + nav_file.writelines(nav.build_literate_nav()) diff --git a/docs/requirements.txt b/docs/requirements.txt index 87a737654f36156daf7af92f3c6e45ae35f3ef65..1e8e2b5f95b55c66d52e774fff67601e5ff7269e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,9 +1,9 @@ -mkdocs>=1.4.0 -mkdocs-material~=9.0.0 -mkdocstrings[python]>=0.18 +mkdocs==1.4.2 +mkdocs-material==9.0.15 +mkdocstrings[python]==0.19 mkdocs-glightbox -mkdocs-section-index~=0.3.4 -mkdocs-literate-nav~=0.5.0 -mkdocs-redirects~=1.2.0 -mkdocs-jupyter~=0.24.0 -mkdocs-gen-files~=0.4.0 \ No newline at end of file +mkdocs-section-index==0.3.5 +mkdocs-literate-nav==0.5.0 +mkdocs-redirects==1.2.0 +mkdocs-jupyter==0.24.0 +mkdocs-gen-files==0.4.0 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 74fe5695afff99b174adf2a8be6de112d609f6cc..55d18f90996a3ebd18df6b22062f84c6d7539d74 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -46,13 +46,6 @@ markdown_extensions: - tables - codehilite - -mkdocstrings.extension: - default_handler: python - handlers: - python: - selector: "python" - syntax: sphinx extra_css: - css/custom.css @@ -61,20 +54,14 @@ plugins: - literate-nav: nav_file: SUMMARY.md - mkdocstrings: - default_handler: python handlers: python: - selector: "python" - syntax: sphinx - # default_handler: python - # handlers: - # python: - # selection: - # docstring_style: sphinx - # line_length: 81 - # merge_init_into_class: true - # show_if_no_docstring: true - # docstring_section_style: list + import: + - https://docs.python-requests.org/en/master/objects.inv + paths: [../src] + synatx: sphinx + docstring_section_style: list + docstring_style: sphinx - search - autorefs - mkdocs-jupyter: @@ -102,9 +89,7 @@ nav: - How to write a notebook: development/how_to_write_xfel_calibrate_notebook_NBC.ipynb - Configuration: development/configuration.md - Advanced topics: development/advanced.md - - Code Reference: - - CALCAT Interface: code_reference/calcat_interface.md - - Code Reference: reference/ + - Code Reference: reference/ - Reference: - FAQ: references/faq.md - Changelog: references/changelog.md