diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 9508649c6dba7e052b2eeb28dcc05574854b5da4..972927d1d4bb0477889c27c4344f3c92bec2fe6c 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree index 04ad1c5ee002d2904556e2490c16ad5d86ff5747..53ef92df8f84208eb66ca04008b5de4f274d560a 100644 Binary files a/docs/_build/doctrees/index.doctree and b/docs/_build/doctrees/index.doctree differ diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt index 6131649d8a3eb62999931d4516d6e26bcd68244d..fcb586eb91c5b6a5bf6c1e32245e5d23b68a160e 100644 --- a/docs/_build/html/_sources/index.txt +++ b/docs/_build/html/_sources/index.txt @@ -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 diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index 31de55410f9dbb983fcf601db5f0592145cf2ef3..19a429f8b57791547e6f4e4f2441d589382c5014 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -6,7 +6,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Welcome to oai-pmh’s documentation! — oai-pmh 3.0 documentation</title> + <title>oai-pmh — 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> »</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’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’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> »</li> </ul> </div> diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 90ecaf9f9bbbdbfd4f912394261cfea6acd9bbe8..687ab264e1bd6e4103175735a1fd093f70383f8d 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{content:0,index:0,modul:0,search:0,page:0},objtypes:{},objnames:{},filenames:["index"],titles:["Welcome to oai-pmh’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 diff --git a/docs/conf.py b/docs/conf.py index 5df1ba115ccf0a7964375869f528b917d8e6fc5f..0d900b506a8ad1190240ac1aa316ca0940b98b0b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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. diff --git a/docs/index.rst b/docs/index.rst index fa56eb3aaa96d7dc62718cda16113864338a11f5..fcb586eb91c5b6a5bf6c1e32245e5d23b68a160e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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