Skip to content

Commit

Permalink
Deploy to GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mmaelicke committed Jan 25, 2024
0 parents commit 0009657
Show file tree
Hide file tree
Showing 190 changed files with 66,967 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 631d9aeb8ec865c8f52d2ada4de9b661
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added .nojekyll
Empty file.
46 changes: 46 additions & 0 deletions _sources/api/api.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
===
API
===

.. toctree::
:maxdepth: 1
:Caption: API Overview
:hidden:

api_connect_database
api_create_tables
api_populate_defaults
api_add_entry
api_add_person
api_add_variable
api_add_group
api_add_license
api_add_keyword
api_add_thesaurus
api_find_entry
api_find_person
api_find_variable
api_find_license
api_find_keyword
api_find_thesaurus
api_show_attributes
api_show_records
api_get_uuid
api_get_logger

Metacatalog API Overview
========================

.. automodule:: metacatalog.api


Command Overview
================

.. nbgallery::
:caption: Command Overview
:name: api-galery
:glob:
:reversed:

api_*
82 changes: 82 additions & 0 deletions _sources/api/api_add_entry.ipynb.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Add Entry"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Entry"
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. autofunction:: metacatalog.api.add_entry"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Add Entry details"
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. autofunction:: metacatalog.api.add_details_to_entries"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Add keywords to entries"
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. autofunction:: metacatalog.api.add_keywords_to_entries\n",
" :noindex:"
]
}
],
"metadata": {
"celltoolbar": "Raw Cell Format",
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.7"
}
},
"nbformat": 4,
"nbformat_minor": 4
}
80 changes: 80 additions & 0 deletions _sources/api/api_add_group.ipynb.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Add EntryGroup"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Group\n",
"\n",
"The grouping of existing Entries can be done by the `api.add_group` endpoint. This function also takes a specification of the type of group. Additionally, there is a `api.add_project` function for the special case of adding a group of type `'Project'`. "
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. note::\n",
"\n",
" ``'Composite'`` entries are best added by the \n",
" `model interface <https://vforwater.github.io/metacatalog/models/models.html>`_ of one of the entries.\n",
" Use the ``Entry.make_composite`` function for that."
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. autofunction:: metacatalog.api.add_group"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Project"
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. autofunction:: metacatalog.api.add_project"
]
}
],
"metadata": {
"celltoolbar": "Raw Cell Format",
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.7"
}
},
"nbformat": 4,
"nbformat_minor": 4
}
65 changes: 65 additions & 0 deletions _sources/api/api_add_keyword.ipynb.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Add keyword"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Keyword"
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. autofunction:: metacatalog.api.add_keyword"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Add keywords to entries"
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. autofunction:: metacatalog.api.add_keywords_to_entries"
]
}
],
"metadata": {
"celltoolbar": "Raw Cell Format",
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.7"
}
},
"nbformat": 4,
"nbformat_minor": 4
}
42 changes: 42 additions & 0 deletions _sources/api/api_add_license.ipynb.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Add license"
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. autofunction:: metacatalog.api.add_license"
]
}
],
"metadata": {
"celltoolbar": "Raw Cell Format",
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.7"
}
},
"nbformat": 4,
"nbformat_minor": 4
}
65 changes: 65 additions & 0 deletions _sources/api/api_add_person.ipynb.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Add Person"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Person"
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. autofunction:: metacatalog.api.add_person"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Add persons to entries"
]
},
{
"cell_type": "raw",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
".. autofunction:: metacatalog.api.add_persons_to_entries"
]
}
],
"metadata": {
"celltoolbar": "Raw Cell Format",
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.7"
}
},
"nbformat": 4,
"nbformat_minor": 4
}
Loading

0 comments on commit 0009657

Please sign in to comment.