[BOT] Automatic documentation build

delph-in · Oct 24, 2023 · 46161a1 · 46161a1
1 parent 37069b5
commit 46161a1
Show file tree

Hide file tree

Showing 21 changed files with 62 additions and 21 deletions.
diff --git a/latestsites/erg/feed.xml b/latestsites/erg/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/erg/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/erg/" rel="alternate" type="text/html" /><updated>2023-10-17T07:00:15+00:00</updated><id>https://delph-in.github.io/docs/erg/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/erg/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/erg/" rel="alternate" type="text/html" /><updated>2023-10-24T06:57:56+00:00</updated><id>https://delph-in.github.io/docs/erg/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
diff --git a/latestsites/erg/sitemap.xml b/latestsites/erg/sitemap.xml
@@ -164,6 +164,6 @@
 </url>
 <url>
 <loc>https://delph-in.github.io/docs/erg/nav.html</loc>
-<lastmod>2023-10-17T06:52:28+00:00</lastmod>
+<lastmod>2023-10-24T06:52:02+00:00</lastmod>
 </url>
 </urlset>
diff --git a/latestsites/garage/LkbLtdb.md b/latestsites/garage/LkbLtdb.md
@@ -113,6 +113,19 @@ in assets/render.js:
 
 The code can be found on github: <https://github.com/fcbond/ltdb>
 
+### Flask branch installation instructions (use this unless you know what you are doing)
+
+- Checkout the flask branch and switch to it
+- Run `./deploy.sh`
+- Check that the database works: copy the local address from the terminal output and open it in the browser (Firefox recommended). You should be able to then use the ERG and the PorGram databases which come with the repository.
+- Move any treebanks you would like to include under `your/grammar/tsdb/gold/`
+- If you want to build your own database: create a virtual environment, activate it, and install `pydelphin`
+- Build your database: navigate to `scripts` and run `python3 grm2db.py your/grammar/METADATA` (you should have a `METADATA file`; model it on the PorGram one, for example)
+- The database gets saved under `/tmp/some-temporary-filename`. You should copy or move it from there to `web/db/` (where the other grammars are).
+- Now if you refresh your browser window, you should be able to see your database under the options.
+
+### Main branch installation instructions (may be outdated?..)
+
 There is a README file that describes how to build the database. The
 code makes certain assumptions:
 
@@ -171,4 +184,4 @@ Corpora (LINC-2005), 31--40, Cheju, Korea.
   - link to some running Lexical Type Databases (like
 [this](https://delph-in.github.io/docs/grammars/JacyLexTypes))
 
-Last update: 2021-06-03 by Olga Zamaraeva [[edit](https://github.com/delph-in/docs/wiki/LkbLtdb/_edit)]{% endraw %}
+Last update: 2023-10-23 by Olga Zamaraeva [[edit](https://github.com/delph-in/docs/wiki/LkbLtdb/_edit)]{% endraw %}
diff --git a/latestsites/garage/LkbLtdb/index.html b/latestsites/garage/LkbLtdb/index.html
@@ -674,6 +674,21 @@ <h2 id="installation">Installation</h2>
 
 <p>The code can be found on github: <a href="https://github.com/fcbond/ltdb">https://github.com/fcbond/ltdb</a></p>
 
+<h3 id="flask-branch-installation-instructions-use-this-unless-you-know-what-you-are-doing">Flask branch installation instructions (use this unless you know what you are doing)</h3>
+
+<ul>
+  <li>Checkout the flask branch and switch to it</li>
+  <li>Run <code class="language-plaintext highlighter-rouge">./deploy.sh</code></li>
+  <li>Check that the database works: copy the local address from the terminal output and open it in the browser (Firefox recommended). You should be able to then use the ERG and the PorGram databases which come with the repository.</li>
+  <li>Move any treebanks you would like to include under <code class="language-plaintext highlighter-rouge">your/grammar/tsdb/gold/</code></li>
+  <li>If you want to build your own database: create a virtual environment, activate it, and install <code class="language-plaintext highlighter-rouge">pydelphin</code></li>
+  <li>Build your database: navigate to <code class="language-plaintext highlighter-rouge">scripts</code> and run <code class="language-plaintext highlighter-rouge">python3 grm2db.py your/grammar/METADATA</code> (you should have a <code class="language-plaintext highlighter-rouge">METADATA file</code>; model it on the PorGram one, for example)</li>
+  <li>The database gets saved under <code class="language-plaintext highlighter-rouge">/tmp/some-temporary-filename</code>. You should copy or move it from there to <code class="language-plaintext highlighter-rouge">web/db/</code> (where the other grammars are).</li>
+  <li>Now if you refresh your browser window, you should be able to see your database under the options.</li>
+</ul>
+
+<h3 id="main-branch-installation-instructions-may-be-outdated">Main branch installation instructions (may be outdated?..)</h3>
+
 <p>There is a README file that describes how to build the database. The
 code makes certain assumptions:</p>
 
@@ -749,7 +764,7 @@ <h2 id="to-do">To Do</h2>
   </li>
 </ul>
 
-<p>Last update: 2021-06-03 by Olga Zamaraeva [<a href="https://github.com/delph-in/docs/wiki/LkbLtdb/_edit">edit</a>]</p>
+<p>Last update: 2023-10-23 by Olga Zamaraeva [<a href="https://github.com/delph-in/docs/wiki/LkbLtdb/_edit">edit</a>]</p>
 
 
       </section>

diff --git a/latestsites/garage/feed.xml b/latestsites/garage/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/garage/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/garage/" rel="alternate" type="text/html" /><updated>2023-10-17T06:59:04+00:00</updated><id>https://delph-in.github.io/docs/garage/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/garage/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/garage/" rel="alternate" type="text/html" /><updated>2023-10-24T06:57:00+00:00</updated><id>https://delph-in.github.io/docs/garage/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
diff --git a/latestsites/garage/sitemap.xml b/latestsites/garage/sitemap.xml
@@ -287,6 +287,6 @@
 </url>
 <url>
 <loc>https://delph-in.github.io/docs/garage/nav.html</loc>
-<lastmod>2023-10-17T06:52:28+00:00</lastmod>
+<lastmod>2023-10-24T06:52:02+00:00</lastmod>
 </url>
 </urlset>
diff --git a/latestsites/grammars/feed.xml b/latestsites/grammars/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/grammars/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/grammars/" rel="alternate" type="text/html" /><updated>2023-10-17T07:00:25+00:00</updated><id>https://delph-in.github.io/docs/grammars/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/grammars/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/grammars/" rel="alternate" type="text/html" /><updated>2023-10-24T06:58:04+00:00</updated><id>https://delph-in.github.io/docs/grammars/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
diff --git a/latestsites/grammars/sitemap.xml b/latestsites/grammars/sitemap.xml
@@ -173,6 +173,6 @@
 </url>
 <url>
 <loc>https://delph-in.github.io/docs/grammars/nav.html</loc>
-<lastmod>2023-10-17T06:52:28+00:00</lastmod>
+<lastmod>2023-10-24T06:52:02+00:00</lastmod>
 </url>
 </urlset>
diff --git a/latestsites/home/feed.xml b/latestsites/home/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/home/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/home/" rel="alternate" type="text/html" /><updated>2023-10-17T06:58:46+00:00</updated><id>https://delph-in.github.io/docs/home/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/home/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/home/" rel="alternate" type="text/html" /><updated>2023-10-24T06:56:46+00:00</updated><id>https://delph-in.github.io/docs/home/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
diff --git a/latestsites/home/sitemap.xml b/latestsites/home/sitemap.xml
@@ -14,6 +14,6 @@
 </url>
 <url>
 <loc>https://delph-in.github.io/docs/home/nav.html</loc>
-<lastmod>2023-10-17T06:52:28+00:00</lastmod>
+<lastmod>2023-10-24T06:52:02+00:00</lastmod>
 </url>
 </urlset>
diff --git a/latestsites/howto/feed.xml b/latestsites/howto/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/howto/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/howto/" rel="alternate" type="text/html" /><updated>2023-10-17T06:58:55+00:00</updated><id>https://delph-in.github.io/docs/howto/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/howto/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/howto/" rel="alternate" type="text/html" /><updated>2023-10-24T06:56:53+00:00</updated><id>https://delph-in.github.io/docs/howto/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
diff --git a/latestsites/howto/sitemap.xml b/latestsites/howto/sitemap.xml
@@ -32,6 +32,6 @@
 </url>
 <url>
 <loc>https://delph-in.github.io/docs/howto/nav.html</loc>
-<lastmod>2023-10-17T06:52:28+00:00</lastmod>
+<lastmod>2023-10-24T06:52:02+00:00</lastmod>
 </url>
 </urlset>
diff --git a/latestsites/index.json b/latestsites/index.json
diff --git a/latestsites/matrix/feed.xml b/latestsites/matrix/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/matrix/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/matrix/" rel="alternate" type="text/html" /><updated>2023-10-17T06:59:31+00:00</updated><id>https://delph-in.github.io/docs/matrix/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/matrix/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/matrix/" rel="alternate" type="text/html" /><updated>2023-10-24T06:57:21+00:00</updated><id>https://delph-in.github.io/docs/matrix/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
diff --git a/latestsites/matrix/sitemap.xml b/latestsites/matrix/sitemap.xml
@@ -317,6 +317,6 @@
 </url>
 <url>
 <loc>https://delph-in.github.io/docs/matrix/nav.html</loc>
-<lastmod>2023-10-17T06:52:28+00:00</lastmod>
+<lastmod>2023-10-24T06:52:02+00:00</lastmod>
 </url>
 </urlset>
diff --git a/latestsites/summits/feed.xml b/latestsites/summits/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/summits/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/summits/" rel="alternate" type="text/html" /><updated>2023-10-17T06:59:44+00:00</updated><id>https://delph-in.github.io/docs/summits/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/summits/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/summits/" rel="alternate" type="text/html" /><updated>2023-10-24T06:57:30+00:00</updated><id>https://delph-in.github.io/docs/summits/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
diff --git a/latestsites/summits/sitemap.xml b/latestsites/summits/sitemap.xml
@@ -986,6 +986,6 @@
 </url>
 <url>
 <loc>https://delph-in.github.io/docs/summits/nav.html</loc>
-<lastmod>2023-10-17T06:52:28+00:00</lastmod>
+<lastmod>2023-10-24T06:52:02+00:00</lastmod>
 </url>
 </urlset>
diff --git a/latestsites/tools/feed.xml b/latestsites/tools/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/tools/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/tools/" rel="alternate" type="text/html" /><updated>2023-10-17T06:59:17+00:00</updated><id>https://delph-in.github.io/docs/tools/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
+<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/tools/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/tools/" rel="alternate" type="text/html" /><updated>2023-10-24T06:57:09+00:00</updated><id>https://delph-in.github.io/docs/tools/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
diff --git a/latestsites/tools/sitemap.xml b/latestsites/tools/sitemap.xml
@@ -398,6 +398,6 @@
 </url>
 <url>
 <loc>https://delph-in.github.io/docs/tools/nav.html</loc>
-<lastmod>2023-10-17T06:52:28+00:00</lastmod>
+<lastmod>2023-10-24T06:52:02+00:00</lastmod>
 </url>
 </urlset>
diff --git a/latestsrc/garage/LkbLtdb.md b/latestsrc/garage/LkbLtdb.md
@@ -113,6 +113,19 @@ in assets/render.js:
 
 The code can be found on github: <https://github.com/fcbond/ltdb>
 
+### Flask branch installation instructions (use this unless you know what you are doing)
+
+- Checkout the flask branch and switch to it
+- Run `./deploy.sh`
+- Check that the database works: copy the local address from the terminal output and open it in the browser (Firefox recommended). You should be able to then use the ERG and the PorGram databases which come with the repository.
+- Move any treebanks you would like to include under `your/grammar/tsdb/gold/`
+- If you want to build your own database: create a virtual environment, activate it, and install `pydelphin`
+- Build your database: navigate to `scripts` and run `python3 grm2db.py your/grammar/METADATA` (you should have a `METADATA file`; model it on the PorGram one, for example)
+- The database gets saved under `/tmp/some-temporary-filename`. You should copy or move it from there to `web/db/` (where the other grammars are).
+- Now if you refresh your browser window, you should be able to see your database under the options.
+
+### Main branch installation instructions (may be outdated?..)
+
 There is a README file that describes how to build the database. The
 code makes certain assumptions:
 
@@ -171,4 +184,4 @@ Corpora (LINC-2005), 31--40, Cheju, Korea.
   - link to some running Lexical Type Databases (like
 [this](https://delph-in.github.io/docs/grammars/JacyLexTypes))
 
-Last update: 2021-06-03 by Olga Zamaraeva [[edit](https://github.com/delph-in/docs/wiki/LkbLtdb/_edit)]{% endraw %}
+Last update: 2023-10-23 by Olga Zamaraeva [[edit](https://github.com/delph-in/docs/wiki/LkbLtdb/_edit)]{% endraw %}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/erg/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/erg/" rel="alternate" type="text/html" /><updated>2023-10-17T07:00:15+00:00</updated><id>https://delph-in.github.io/docs/erg/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>
		<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="https://delph-in.github.io/docs/erg/feed.xml" rel="self" type="application/atom+xml" /><link href="https://delph-in.github.io/docs/erg/" rel="alternate" type="text/html" /><updated>2023-10-24T06:57:56+00:00</updated><id>https://delph-in.github.io/docs/erg/feed.xml</id><title type="html">DELPH-IN</title><subtitle>DELPH-IN Documentation</subtitle><author><name>DELPH-IN</name></author></feed>