From b4dc7d83352ab9cd359fadf79d8933c1ce6298d3 Mon Sep 17 00:00:00 2001
From: Karim Ahmed <karim.ahmed@xfel.eu>
Date: Wed, 12 Apr 2023 11:41:19 +0200
Subject: [PATCH] specify nb path
---
docs/development/workflow.md | 2 +-
docs/gen_ref_pages.py | 13 ++++++++-----
docs/operation.md | 1 -
mkdocs.yml | 5 +++--
4 files changed, 12 insertions(+), 9 deletions(-)
delete mode 100644 docs/operation.md
diff --git a/docs/development/workflow.md b/docs/development/workflow.md
index 65ddbf1e9..c804e3f75 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 4a7520d6f..289388880 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 ddf0c5b7e..000000000
--- 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 f37bc60ed..6514ad166 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
--
GitLab