Skip to content
Snippets Groups Projects
Commit b4dc7d83 authored by Karim Ahmed's avatar Karim Ahmed Committed by Karim Ahmed
Browse files

specify nb path

parent 01a21811
No related branches found
No related tags found
1 merge request!820[Documentation] Introduce mkdocs and add new documentation pages
......@@ -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
......
......@@ -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"]:
![Calibration DB Remote avoided](xfel-calibrate_cli_process_no_caldbremote.png)
""",
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())
# Operation page
\ No newline at end of file
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment