PostgREST · wolfgangwalther · Jan 30, 2022 · Jan 30, 2022
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,6 @@
+version: 2
+sphinx:
+  configuration: docs/conf.py
+python:
+   install:
+   - requirements: requirements.txt
diff --git a/default.nix b/default.nix
@@ -31,7 +31,7 @@ in
         # clean previous build, otherwise some errors might be supressed
         rm -rf _build
 
-        ${python}/bin/sphinx-build --color -W -b html -a -n . _build
+        ${python}/bin/sphinx-build --color -W -b html -a -n docs _build
       '';
 
   serve =
@@ -50,7 +50,7 @@ in
       ''
         set -euo pipefail
 
-        FILES=$(find . -type f -iname '*.rst' | tr '\n' ' ')
+        FILES=$(find docs -type f -iname '*.rst' | tr '\n' ' ')
 
         cat $FILES \
          | grep -v '^\(\.\.\|  \)' \
@@ -67,7 +67,7 @@ in
       ''
         set -euo pipefail
 
-        FILES=$(find . -type f -iname '*.rst' | tr '\n' ' ')
+        FILES=$(find docs -type f -iname '*.rst' | tr '\n' ' ')
 
         cat postgrest.dict \
          | tail -n+2 \
@@ -81,6 +81,6 @@ in
       ''
         set -euo pipefail
 
-        ${python}/bin/sphinx-build --color -b linkcheck . _build
+        ${python}/bin/sphinx-build --color -b linkcheck docs _build
       '';
 }
diff --git a/diagrams/README.md b/diagrams/README.md
@@ -5,7 +5,7 @@ The ER diagrams were created with https://github.com/BurntSushi/erd/.
 You can go download erd from https://github.com/BurntSushi/erd/releases and then do:
 
 ```bash
-./erd_static-x86-64 -i diagrams/film.er -o _static/film.png
+./erd_static-x86-64 -i diagrams/film.er -o docs/_static/film.png
 ```
 
 ## LaTeX
@@ -18,7 +18,7 @@ Then use this command to generate the png file.
 pdflatex --shell-escape -halt-on-error db.tex
 
 ## and move it to the static folder(it's not easy to do it in one go with the pdflatex)
-mv db.png ../_static/
+mv db.png ../docs/_static/
 ```
 
 LaTeX is used because it's a tweakable plain text format.

diff --git a/_static/2ndquadrant.png → docs/_static/2ndquadrant.png b/_static/2ndquadrant.png → docs/_static/2ndquadrant.png
diff --git a/_static/css/custom.css → docs/_static/css/custom.css b/_static/css/custom.css → docs/_static/css/custom.css
diff --git a/_static/cybertec-new.png → docs/_static/cybertec-new.png b/_static/cybertec-new.png → docs/_static/cybertec-new.png
diff --git a/_static/cybertec.png → docs/_static/cybertec.png b/_static/cybertec.png → docs/_static/cybertec.png
diff --git a/_static/db.png → docs/_static/db.png b/_static/db.png → docs/_static/db.png
diff --git a/_static/empty.png → docs/_static/empty.png b/_static/empty.png → docs/_static/empty.png
diff --git a/_static/favicon.ico → docs/_static/favicon.ico b/_static/favicon.ico → docs/_static/favicon.ico
diff --git a/_static/film.png → docs/_static/film.png b/_static/film.png → docs/_static/film.png
diff --git a/_static/gnuhost.png → docs/_static/gnuhost.png b/_static/gnuhost.png → docs/_static/gnuhost.png
diff --git a/_static/logo.png → docs/_static/logo.png b/_static/logo.png → docs/_static/logo.png
diff --git a/_static/oblivious.jpg → docs/_static/oblivious.jpg b/_static/oblivious.jpg → docs/_static/oblivious.jpg
diff --git a/_static/orders.png → docs/_static/orders.png b/_static/orders.png → docs/_static/orders.png
diff --git a/_static/retool.png → docs/_static/retool.png b/_static/retool.png → docs/_static/retool.png
diff --git a/_static/security-anon-choice.png → docs/_static/security-anon-choice.png b/_static/security-anon-choice.png → docs/_static/security-anon-choice.png
diff --git a/_static/security-roles.png → docs/_static/security-roles.png b/_static/security-roles.png → docs/_static/security-roles.png
diff --git a/_static/supabase.png → docs/_static/supabase.png b/_static/supabase.png → docs/_static/supabase.png
diff --git a/_static/timescaledb.png → docs/_static/timescaledb.png b/_static/timescaledb.png → docs/_static/timescaledb.png
diff --git a/_static/tuts/tut0-request-flow.png → docs/_static/tuts/tut0-request-flow.png b/_static/tuts/tut0-request-flow.png → docs/_static/tuts/tut0-request-flow.png
diff --git a/_static/tuts/tut1-jwt-io.png → docs/_static/tuts/tut1-jwt-io.png b/_static/tuts/tut1-jwt-io.png → docs/_static/tuts/tut1-jwt-io.png
diff --git a/_static/win-err-dialog.png → docs/_static/win-err-dialog.png b/_static/win-err-dialog.png → docs/_static/win-err-dialog.png
diff --git a/admin.rst → docs/admin.rst b/admin.rst → docs/admin.rst
diff --git a/api.rst → docs/api.rst b/api.rst → docs/api.rst
diff --git a/auth.rst → docs/auth.rst b/auth.rst → docs/auth.rst
diff --git a/conf.py → docs/conf.py b/conf.py → docs/conf.py
diff --git a/configuration.rst → docs/configuration.rst b/configuration.rst → docs/configuration.rst
diff --git a/ecosystem.rst → docs/ecosystem.rst b/ecosystem.rst → docs/ecosystem.rst
diff --git a/how-tos/casting-type-to-custom-json.rst → docs/how-tos/casting-type-to-custom-json.rst b/how-tos/casting-type-to-custom-json.rst → docs/how-tos/casting-type-to-custom-json.rst
diff --git a/...s/embedding-table-from-another-schema.rst → ...s/embedding-table-from-another-schema.rst b/...s/embedding-table-from-another-schema.rst → ...s/embedding-table-from-another-schema.rst
diff --git a/how-tos/providing-images-for-img.rst → docs/how-tos/providing-images-for-img.rst b/how-tos/providing-images-for-img.rst → docs/how-tos/providing-images-for-img.rst
diff --git a/index.rst → docs/index.rst b/index.rst → docs/index.rst
diff --git a/install.rst → docs/install.rst b/install.rst → docs/install.rst
diff --git a/releases/v5.2.0.rst → docs/releases/v5.2.0.rst b/releases/v5.2.0.rst → docs/releases/v5.2.0.rst
diff --git a/releases/v6.0.2.rst → docs/releases/v6.0.2.rst b/releases/v6.0.2.rst → docs/releases/v6.0.2.rst
diff --git a/releases/v7.0.0.rst → docs/releases/v7.0.0.rst b/releases/v7.0.0.rst → docs/releases/v7.0.0.rst
diff --git a/releases/v7.0.1.rst → docs/releases/v7.0.1.rst b/releases/v7.0.1.rst → docs/releases/v7.0.1.rst
diff --git a/releases/v8.0.0.rst → docs/releases/v8.0.0.rst b/releases/v8.0.0.rst → docs/releases/v8.0.0.rst
diff --git a/releases/v9.0.0.rst → docs/releases/v9.0.0.rst b/releases/v9.0.0.rst → docs/releases/v9.0.0.rst
diff --git a/schema_cache.rst → docs/schema_cache.rst b/schema_cache.rst → docs/schema_cache.rst
diff --git a/schema_structure.rst → docs/schema_structure.rst b/schema_structure.rst → docs/schema_structure.rst
diff --git a/tutorials/tut0.rst → docs/tutorials/tut0.rst b/tutorials/tut0.rst → docs/tutorials/tut0.rst
diff --git a/tutorials/tut1.rst → docs/tutorials/tut1.rst b/tutorials/tut1.rst → docs/tutorials/tut1.rst
diff --git a/livereload_docs.py b/livereload_docs.py
@@ -2,12 +2,12 @@
 from livereload import Server, shell
 from subprocess import call
 ## Build docs at startup
-call(['sphinx-build', '-b', 'html', '-a', '-n', '.', '_build'])
+call(['sphinx-build', '-b', 'html', '-a', '-n', 'docs', '_build'])
 server = Server()
-server.watch('*.rst', shell('sphinx-build -b html -a -n . _build'))
-server.watch('tutorials/*.rst', shell('sphinx-build -b html -a -n . _build'))
-server.watch('how-tos/*.rst', shell('sphinx-build -b html -a -n . _build'))
-server.watch('releases/*.rst', shell('sphinx-build -b html -a -n . _build'))
+server.watch('*.rst', shell('sphinx-build -b html -a -n docs _build'))
+server.watch('tutorials/*.rst', shell('sphinx-build -b html -a -n docs _build'))
+server.watch('how-tos/*.rst', shell('sphinx-build -b html -a -n docs _build'))
+server.watch('releases/*.rst', shell('sphinx-build -b html -a -n docs _build'))
 # For custom port and host
 # server.serve(root='_build/', host='192.168.1.2')
 server.serve(root='_build/')