diff --git a/docs/_config.yml b/docs/_config.yml index c1a1e76..3829706 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -3,61 +3,6 @@ description: "Documentation for VRE Hub Zenodo Jupyter Lab Extension" remote_theme: pmarsceill/just-the-docs color_scheme: dark -# Table of contents -nav: - - title: "Home" - url: / - nav_order: 1 - - - title: "Install" - url: /install/ - nav_order: 2 - children: - - title: "For End-Users" - url: /install/#for-end-users-users - - title: "For Developers" - url: /install/##for-developers-developers - - - title: "Frontend Usage" - url: /usage/ - nav_order: 3 - - - title: "Full Documentation" - url: /documentation/ - nav_order: 4 - children: - - title: "Frontend Documentation" - url: /documentation/frontend/ - nav_order: 1 - children: - - title: "General Framework" - url: /documentation/frontend/#general-framework - - title: "Files in `src/`" - url: /documentation/frontend/#files-in-src - - title: "`index.tsx`" - url: /documentation/frontend/#index - - title: "`API/API_functions.tsx`" - url: /documentation/frontend/#api_functions - - title: "`API/handlers.tsx`" - url: /documentation/frontend/#handler - - title: "`components/FileBrowser.tsx`" - url: /documentation/frontend/#filebrowser - - title: "`components/NavBar.tsx`" - url: /documentation/frontend/#navbar - - title: "`components/SearchPanel.tsx`" - url: /documentation/frontend/#searchpanel - - title: "`components/SideBarPanel.tsx`" - url: /documentation/frontend/#sidebar - - title: "`components/confirmation.tsx`" - url: /documentation/frontend/#confirmation - - title: "`components/login.tsx`" - url: /documentation/frontend/#login - - title: "`components/upload.tsx`" - url: /documentation/frontend/#upload - - title: "Backend Documentation" - url: /documentation/backend/ - nav_order: 2 - sass: load_paths: - _sass diff --git a/docs/documentation/backend.md b/docs/documentation/backend.md index 845d011..70f6486 100644 --- a/docs/documentation/backend.md +++ b/docs/documentation/backend.md @@ -9,11 +9,11 @@ nav_order: 2 ## General Framework The backend for this extension is built as a Jupyter Server Extension. The project entry points are specified with the `pyproject.toml` file in the root directory. These point to the `zenodo_jupyterlab.server` module, which contains the `extenion.py` and `__init__.py` files which run the function that sets up the API handlers defined within other files in that directory. This guide will go through each section, with explanation of functionality. -## Files in `zenodo_jupyterlab/server' -* ['extension.py`](#extension) -* ['__init__.py`](#init) -* ['handlers.py`](#handlers) -* ['search.py`](#search) +## Files in `zenodo_jupyterlab/server/` +* [`extension.py`](#extension) +* [`__init__.py`](#init) +* [`handlers.py`](#handlers) +* [`search.py`](#search) * [`testConnection.py`](#testConnection) * [`upload.py`](#upload) @@ -161,7 +161,7 @@ Uses `eossr.api.zenodo.ZenodoAPI.create_new_deposit` to create an empty deposit. > **Returns:** ID of the newly created record ### `createMetadata(zAPI: eossr.api.zenodo.ZenodoAPI, recordID: int, form_data: FormData object)` -*Work in Progress* +*Work in Progress*\ Extracts title from form_data and creates a JSON dict as follows: ``` json_metadata = { diff --git a/docs/documentation/frontend.md b/docs/documentation/frontend.md index e773e36..318c917 100644 --- a/docs/documentation/frontend.md +++ b/docs/documentation/frontend.md @@ -7,7 +7,7 @@ nav_order: 1 # Frontend Documentation ## General Framework {#general-framework} -The building of the of the frontend JupyterLab extension is handled entirely within `pyproject.toml` in the root directory. The details of that file are discussed [NEED A PLACE TO LINK HERE WHEN I MAKE IT]. All of the frontend components were originally generated with `copier` template of a JupyterLab extension: [template](https://github.com/jupyterlab/extension-template). This extension is built with NodeJS >= 20 with node dependencies contained within `yarn.lock`. +The building of the of the frontend JupyterLab extension is handled entirely within `pyproject.toml` in the root directory, which was originally generated from the `copier` template. All of the frontend components were originally generated with `copier` template of a JupyterLab extension: [template](https://github.com/jupyterlab/extension-template). This extension is built with NodeJS >= 20 with node dependencies contained within `yarn.lock`. ## Files in `src/` {#files-in-src} * [`index.tsx`](#index) diff --git a/docs/index.md b/docs/index.md index 30fe1c7..c3ef88a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,8 +12,9 @@ nav_order: 1 This project integrates [Zenodo](https://zenodo.org) into Jupyter Lab extension. # Requirements -JupyterLab > 4, < 5 -Notebook < 7 +JupyterLab > 4, < 5\ +Notebook < 7\ eOSSR +# Motivation This project is being developed as a part of the Virtual Research Environment ([VRE](https://github.com/vre-hub)) initiative, created as a part of the [ESCAPE Collaboration](https://projectescape.eu/). The end goal of the VRE is to develop a Hub which aggregates software and infrastructure to create an end-to-end analysis facility for physicists. \ No newline at end of file diff --git a/docs/install/index.md b/docs/install/index.md index 7824605..5498604 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -19,7 +19,7 @@ The following steps require NodeJS >= 20. Install `yarn`:\ `npm install -g corepack`\ -`corepack enable`\ +`corepack enable` Install Python dependecies:\ `python3 -m pip install -r requirements.txt`