diff --git a/docs/development/workflow.md b/docs/development/workflow.md index 65ddbf1e9c4b215d9263fc2dbe121bbc16904c70..c804e3f75036e8b7d21f8c0af2b3b8fdb7b3289d 100644 --- a/docs/development/workflow.md +++ b/docs/development/workflow.md @@ -55,7 +55,7 @@ We welcome contributions to the pipeline if you have calibration notebooks or al 6. Share and collaborate - Share your notebook on [GitLab](https://git.xfel.eu/) to start seeking feedback and begin the reviewing process. [A guide on how to share changes on gitlab](contributing_on_gitlab.md) + Share your notebook on [GitLab](https://git.xfel.eu/) to start seeking feedback and begin the reviewing process. ## Write notebook to execute using xfel-calibrate diff --git a/docs/gen_ref_pages.py b/docs/gen_ref_pages.py index 4a7520d6ffce1072a18bf1f4886e92c37058f40e..2893888804ad0c3670200df5f3c18a3f988dbf65 100644 --- a/docs/gen_ref_pages.py +++ b/docs/gen_ref_pages.py @@ -17,9 +17,13 @@ for directory in ["src"]: parts = list(module_path.parts) - if parts[-1] in ["notebooks", "settings", "restful_config", - "__main__", "__init__", "listen_kafka", "sqlite_view", "manual_launch" - "messages", ]: + if parts[-1] in [ + "notebooks", "settings", + "restful_config", "__main__", + "__init__", "listen_kafka", + "sqlite_view", "manual_launch" + "messages", + ]: continue nav[parts] = doc_path.as_posix() @@ -34,10 +38,9 @@ for directory in ["src"]:  """, file=fd) - print("::: " + identifier, file=fd) + print("::: " + "src." + identifier, file=fd) mkdocs_gen_files.set_edit_path(full_doc_path, path) with mkdocs_gen_files.open(f"reference/SUMMARY.md", "w") as nav_file: - print(nav.build_literate_nav()) nav_file.writelines(nav.build_literate_nav()) diff --git a/docs/operation.md b/docs/operation.md deleted file mode 100644 index ddf0c5b7eb05909fbae06f31b0ffe81948d1b54b..0000000000000000000000000000000000000000 --- a/docs/operation.md +++ /dev/null @@ -1 +0,0 @@ -# Operation page \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index f37bc60ed01b1dea5d70273b6bb9615166bd299c..6514ad166c014bea06f556f60d41e59a85526582 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,7 +66,7 @@ plugins: - search - autorefs - mkdocs-jupyter: - include: ["*.ipynb"] + include: ["development/how_to_write_xfel_calibrate_notebook_NBC.ipynb"] allow_errors: false - gen-files: scripts: @@ -79,9 +79,10 @@ plugins: python: import: - https://docs.python-requests.org/en/master/objects.inv - paths: [src, webservice] + paths: [src] docstring_style: sphinx docstring_section_style: list + repo_url: https://git.xfel.eu/calibration/pycalibration