chore: Move *.rst files to docs/ folder

Signed-off-by: Wolfgang Walther <walther@technowledgy.de>

.readthedocs.yaml

@@ -0,0 +1,6 @@
+version: 2
+sphinx:
+  configuration: docs/conf.py
+python:
+   install:
+   - requirements: requirements.txt

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
       '';
 }

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.

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('*.rst', shell('sphinx-build -b html -a -n docs _build'))
-server.watch('tutorials/*.rst', shell('sphinx-build -b html -a -n . _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 . _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 . _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/')