Skip to content
Snippets Groups Projects
Commit c9950425 authored by mbrodhu's avatar mbrodhu
Browse files

api doku

parent ce4d4cb8
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
docs/_build/doctrees/environment.pickle
+ 0
− 0
View file @ c9950425
No preview for this file type
docs/_build/doctrees/index.doctree
+ 0
− 0
View file @ c9950425
No preview for this file type
docs/_build/html/_sources/index.txt
+ 18
− 7
View file @ c9950425
......@@ -3,20 +3,31 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to oai-pmh's documentation!
oai-pmh
===================================
Contents:
oai-pmh is the service to harvest all metadata from the editions stored in the textgrid repository
Dependencies
------------
* ElasticSearch
API Documentation
-----------------
.. toctree::
:maxdepth: 2
api/oai.rst
License
-------
Indices and tables
==================
See LICENCE_
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _LICENCE: https://projects.gwdg.de/projects/oai-pmh/repository/revisions/master/raw/LICENSE.txt
docs/_build/html/index.html
+ 35
− 15
View file @ c9950425
......@@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to oai-pmh’s documentation! &mdash; oai-pmh 3.0 documentation</title>
<title>oai-pmh &mdash; oai-pmh 3.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
......@@ -23,7 +23,8 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="oai-pmh 3.0 documentation" href="#" />
<link rel="top" title="oai-pmh 3.0 documentation" href="#" />
<link rel="next" title="GET /oai" href="api/oai.html" />
</head>
<body>
<div class="related">
......@@ -32,6 +33,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="api/oai.html" title="GET /oai"
accesskey="N">next</a> |</li>
<li><a href="#">oai-pmh 3.0 documentation</a> &raquo;</li>
</ul>
</div>
......@@ -41,21 +45,27 @@
<div class="bodywrapper">
<div class="body">
<div class="section" id="welcome-to-oai-pmh-s-documentation">
<h1>Welcome to oai-pmh&#8217;s documentation!<a class="headerlink" href="#welcome-to-oai-pmh-s-documentation" title="Permalink to this headline"></a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<div class="section" id="oai-pmh">
<h1>oai-pmh<a class="headerlink" href="#oai-pmh" title="Permalink to this headline"></a></h1>
<p>oai-pmh is the service to harvest all metadata from the editions stored in the textgrid repository</p>
<div class="section" id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>ElasticSearch</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
<div class="section" id="api-documentation">
<h2>API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/oai.html">GET /oai</a></li>
</ul>
</div>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
<p>See <a class="reference external" href="https://projects.gwdg.de/projects/oai-pmh/repository/revisions/master/raw/LICENSE.txt">LICENCE</a></p>
</div>
</div>
......@@ -66,10 +76,17 @@
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to oai-pmh&#8217;s documentation!</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
<li><a class="reference internal" href="#">oai-pmh</a><ul>
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li><a class="reference internal" href="#api-documentation">API Documentation</a></li>
<li><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="api/oai.html"
title="next chapter">GET /oai</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
......@@ -98,6 +115,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="api/oai.html" title="GET /oai"
>next</a> |</li>
<li><a href="#">oai-pmh 3.0 documentation</a> &raquo;</li>
</ul>
</div>
......
docs/_build/html/searchindex.js
+ 1
− 1
View file @ c9950425
Search.setIndex({envversion:42,terms:{content:0,index:0,modul:0,search:0,page:0},objtypes:{},objnames:{},filenames:["index"],titles:["Welcome to oai-pmh&#8217;s documentation!"],objects:{},titleterms:{welcom:0,oai:0,indic:0,tabl:0,document:0,pmh:0}})
\ No newline at end of file
Search.setIndex({envversion:42,terms:{test1:1,all:[0,1],belong:1,identifi:1,show:1,text:1,datestamp:1,paramet:1,xml:1,"21t12":1,onli:1,everi:1,string:1,format:1,getrecord:1,verb:1,requir:1,specif:1,edit:[0,1],possibl:1,michael:1,leuk:1,listidentifi:1,item:1,page:[],www:1,be58:1,some:1,see:[0,1],aggreg:1,respons:1,further:1,index:[],section:1,content:[],"43z":1,metadata:[0,1],"8741f26c":1,insid:1,responsed:1,repositori:[0,1],valu:1,search:[],"85e9":1,drama:1,amount:1,elasticsearch:0,listrecord:1,modul:[],header:1,d618ffeec722:1,contributor:1,given:1,from:0,support:1,"45fb":1,tgpr:1,licenc:0,type:1,store:0,listset:1,"68d8":1,gwdg:1,regard:1,about:1,sessionid:[],ns2:1,ns3:1,harvest:[0,1],textgrid:[0,1],provid:1,servic:0,metadataprefix:1,structur:1,tgoaipmh:1,project:1,record:1,limit:1,can:1,"18z":1,werk:1,hdl:1,descript:1,textgridrep:1,curl:1,option:1,filter:1,b5d1:1,b068ff71:1,"12t11":1,titl:1,"12t12":1,listmetadataformat:1,same:1,other:1,which:1,relat:1,http:1,metadataformat:1,object:1,date:1,metadatformat:1,"807e":1,identi:[],"54b3b5d26ded":1,oai_dc:1,request:1,uri:1,inform:1,exampl:1,thi:1},objtypes:{},objnames:{},filenames:["index","api/oai"],titles:["oai-pmh","GET /oai"],objects:{},titleterms:{depend:0,welcom:[],get:1,licens:0,oai:[0,1],api:0,indic:[],tabl:[],document:0,pmh:0}})
\ No newline at end of file
docs/conf.py
+ 1
− 0
View file @ c9950425
......@@ -32,6 +32,7 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinxcontrib.httpdomain',
]
# Add any paths that contain templates here, relative to this directory.
......
docs/index.rst
+ 1
− 7
View file @ c9950425
......@@ -21,13 +21,7 @@ API Documentation
.. toctree::
:maxdepth: 2
api/identify.rst
api/listRecords.rst
api/getGrecord.rst
api/listMetadataFormats.rst
api/listSets.rst
api/set.rst
api/resumptionToken.rst
api/oai.rst
License
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment