Skip to content

Commit

Permalink
slight fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mrzengel committed Aug 7, 2024
1 parent 70d39e8 commit 5b8ceec
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 65 deletions.
55 changes: 0 additions & 55 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions docs/documentation/backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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 = {
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
5 changes: 3 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 5b8ceec

Please sign in to comment.