From 8863e4b3ad0996184564fb2b4e02c3a3fec5affd Mon Sep 17 00:00:00 2001 From: Wolfgang Walther Date: Sun, 30 Jan 2022 10:54:36 +0100 Subject: [PATCH] chore: Move *.rst files to docs/ folder Signed-off-by: Wolfgang Walther --- .readthedocs.yaml | 6 ++++++ default.nix | 8 ++++---- diagrams/README.md | 4 ++-- {_static => docs/_static}/2ndquadrant.png | Bin {_static => docs/_static}/css/custom.css | 0 {_static => docs/_static}/cybertec-new.png | Bin {_static => docs/_static}/cybertec.png | Bin {_static => docs/_static}/db.png | Bin {_static => docs/_static}/empty.png | Bin {_static => docs/_static}/favicon.ico | Bin {_static => docs/_static}/film.png | Bin {_static => docs/_static}/gnuhost.png | Bin {_static => docs/_static}/logo.png | Bin {_static => docs/_static}/oblivious.jpg | Bin {_static => docs/_static}/orders.png | Bin {_static => docs/_static}/retool.png | Bin {_static => docs/_static}/security-anon-choice.png | Bin {_static => docs/_static}/security-roles.png | Bin {_static => docs/_static}/supabase.png | Bin {_static => docs/_static}/timescaledb.png | Bin .../_static}/tuts/tut0-request-flow.png | Bin {_static => docs/_static}/tuts/tut1-jwt-io.png | Bin {_static => docs/_static}/win-err-dialog.png | Bin admin.rst => docs/admin.rst | 0 api.rst => docs/api.rst | 0 auth.rst => docs/auth.rst | 0 conf.py => docs/conf.py | 0 configuration.rst => docs/configuration.rst | 0 ecosystem.rst => docs/ecosystem.rst | 0 .../how-tos}/casting-type-to-custom-json.rst | 0 .../embedding-table-from-another-schema.rst | 0 .../how-tos}/providing-images-for-img.rst | 0 index.rst => docs/index.rst | 0 install.rst => docs/install.rst | 0 {releases => docs/releases}/v5.2.0.rst | 0 {releases => docs/releases}/v6.0.2.rst | 0 {releases => docs/releases}/v7.0.0.rst | 0 {releases => docs/releases}/v7.0.1.rst | 0 {releases => docs/releases}/v8.0.0.rst | 0 {releases => docs/releases}/v9.0.0.rst | 0 schema_cache.rst => docs/schema_cache.rst | 0 schema_structure.rst => docs/schema_structure.rst | 0 {tutorials => docs/tutorials}/tut0.rst | 0 {tutorials => docs/tutorials}/tut1.rst | 0 livereload_docs.py | 10 +++++----- 45 files changed, 17 insertions(+), 11 deletions(-) create mode 100644 .readthedocs.yaml rename {_static => docs/_static}/2ndquadrant.png (100%) rename {_static => docs/_static}/css/custom.css (100%) rename {_static => docs/_static}/cybertec-new.png (100%) rename {_static => docs/_static}/cybertec.png (100%) rename {_static => docs/_static}/db.png (100%) rename {_static => docs/_static}/empty.png (100%) rename {_static => docs/_static}/favicon.ico (100%) rename {_static => docs/_static}/film.png (100%) rename {_static => docs/_static}/gnuhost.png (100%) rename {_static => docs/_static}/logo.png (100%) rename {_static => docs/_static}/oblivious.jpg (100%) rename {_static => docs/_static}/orders.png (100%) rename {_static => docs/_static}/retool.png (100%) rename {_static => docs/_static}/security-anon-choice.png (100%) rename {_static => docs/_static}/security-roles.png (100%) rename {_static => docs/_static}/supabase.png (100%) rename {_static => docs/_static}/timescaledb.png (100%) rename {_static => docs/_static}/tuts/tut0-request-flow.png (100%) rename {_static => docs/_static}/tuts/tut1-jwt-io.png (100%) rename {_static => docs/_static}/win-err-dialog.png (100%) rename admin.rst => docs/admin.rst (100%) rename api.rst => docs/api.rst (100%) rename auth.rst => docs/auth.rst (100%) rename conf.py => docs/conf.py (100%) rename configuration.rst => docs/configuration.rst (100%) rename ecosystem.rst => docs/ecosystem.rst (100%) rename {how-tos => docs/how-tos}/casting-type-to-custom-json.rst (100%) rename {how-tos => docs/how-tos}/embedding-table-from-another-schema.rst (100%) rename {how-tos => docs/how-tos}/providing-images-for-img.rst (100%) rename index.rst => docs/index.rst (100%) rename install.rst => docs/install.rst (100%) rename {releases => docs/releases}/v5.2.0.rst (100%) rename {releases => docs/releases}/v6.0.2.rst (100%) rename {releases => docs/releases}/v7.0.0.rst (100%) rename {releases => docs/releases}/v7.0.1.rst (100%) rename {releases => docs/releases}/v8.0.0.rst (100%) rename {releases => docs/releases}/v9.0.0.rst (100%) rename schema_cache.rst => docs/schema_cache.rst (100%) rename schema_structure.rst => docs/schema_structure.rst (100%) rename {tutorials => docs/tutorials}/tut0.rst (100%) rename {tutorials => docs/tutorials}/tut1.rst (100%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..3bce02afa --- /dev/null +++ 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 index 651046e36..5dffe887a 100644 --- 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 index 36fd9911d..67009dc31 100644 --- 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 b/docs/_static/2ndquadrant.png similarity index 100% rename from _static/2ndquadrant.png rename to docs/_static/2ndquadrant.png diff --git a/_static/css/custom.css b/docs/_static/css/custom.css similarity index 100% rename from _static/css/custom.css rename to docs/_static/css/custom.css diff --git a/_static/cybertec-new.png b/docs/_static/cybertec-new.png similarity index 100% rename from _static/cybertec-new.png rename to docs/_static/cybertec-new.png diff --git a/_static/cybertec.png b/docs/_static/cybertec.png similarity index 100% rename from _static/cybertec.png rename to docs/_static/cybertec.png diff --git a/_static/db.png b/docs/_static/db.png similarity index 100% rename from _static/db.png rename to docs/_static/db.png diff --git a/_static/empty.png b/docs/_static/empty.png similarity index 100% rename from _static/empty.png rename to docs/_static/empty.png diff --git a/_static/favicon.ico b/docs/_static/favicon.ico similarity index 100% rename from _static/favicon.ico rename to docs/_static/favicon.ico diff --git a/_static/film.png b/docs/_static/film.png similarity index 100% rename from _static/film.png rename to docs/_static/film.png diff --git a/_static/gnuhost.png b/docs/_static/gnuhost.png similarity index 100% rename from _static/gnuhost.png rename to docs/_static/gnuhost.png diff --git a/_static/logo.png b/docs/_static/logo.png similarity index 100% rename from _static/logo.png rename to docs/_static/logo.png diff --git a/_static/oblivious.jpg b/docs/_static/oblivious.jpg similarity index 100% rename from _static/oblivious.jpg rename to docs/_static/oblivious.jpg diff --git a/_static/orders.png b/docs/_static/orders.png similarity index 100% rename from _static/orders.png rename to docs/_static/orders.png diff --git a/_static/retool.png b/docs/_static/retool.png similarity index 100% rename from _static/retool.png rename to docs/_static/retool.png diff --git a/_static/security-anon-choice.png b/docs/_static/security-anon-choice.png similarity index 100% rename from _static/security-anon-choice.png rename to docs/_static/security-anon-choice.png diff --git a/_static/security-roles.png b/docs/_static/security-roles.png similarity index 100% rename from _static/security-roles.png rename to docs/_static/security-roles.png diff --git a/_static/supabase.png b/docs/_static/supabase.png similarity index 100% rename from _static/supabase.png rename to docs/_static/supabase.png diff --git a/_static/timescaledb.png b/docs/_static/timescaledb.png similarity index 100% rename from _static/timescaledb.png rename to docs/_static/timescaledb.png diff --git a/_static/tuts/tut0-request-flow.png b/docs/_static/tuts/tut0-request-flow.png similarity index 100% rename from _static/tuts/tut0-request-flow.png rename to docs/_static/tuts/tut0-request-flow.png diff --git a/_static/tuts/tut1-jwt-io.png b/docs/_static/tuts/tut1-jwt-io.png similarity index 100% rename from _static/tuts/tut1-jwt-io.png rename to docs/_static/tuts/tut1-jwt-io.png diff --git a/_static/win-err-dialog.png b/docs/_static/win-err-dialog.png similarity index 100% rename from _static/win-err-dialog.png rename to docs/_static/win-err-dialog.png diff --git a/admin.rst b/docs/admin.rst similarity index 100% rename from admin.rst rename to docs/admin.rst diff --git a/api.rst b/docs/api.rst similarity index 100% rename from api.rst rename to docs/api.rst diff --git a/auth.rst b/docs/auth.rst similarity index 100% rename from auth.rst rename to docs/auth.rst diff --git a/conf.py b/docs/conf.py similarity index 100% rename from conf.py rename to docs/conf.py diff --git a/configuration.rst b/docs/configuration.rst similarity index 100% rename from configuration.rst rename to docs/configuration.rst diff --git a/ecosystem.rst b/docs/ecosystem.rst similarity index 100% rename from ecosystem.rst rename to docs/ecosystem.rst diff --git a/how-tos/casting-type-to-custom-json.rst b/docs/how-tos/casting-type-to-custom-json.rst similarity index 100% rename from how-tos/casting-type-to-custom-json.rst rename to docs/how-tos/casting-type-to-custom-json.rst diff --git a/how-tos/embedding-table-from-another-schema.rst b/docs/how-tos/embedding-table-from-another-schema.rst similarity index 100% rename from how-tos/embedding-table-from-another-schema.rst rename to docs/how-tos/embedding-table-from-another-schema.rst diff --git a/how-tos/providing-images-for-img.rst b/docs/how-tos/providing-images-for-img.rst similarity index 100% rename from how-tos/providing-images-for-img.rst rename to docs/how-tos/providing-images-for-img.rst diff --git a/index.rst b/docs/index.rst similarity index 100% rename from index.rst rename to docs/index.rst diff --git a/install.rst b/docs/install.rst similarity index 100% rename from install.rst rename to docs/install.rst diff --git a/releases/v5.2.0.rst b/docs/releases/v5.2.0.rst similarity index 100% rename from releases/v5.2.0.rst rename to docs/releases/v5.2.0.rst diff --git a/releases/v6.0.2.rst b/docs/releases/v6.0.2.rst similarity index 100% rename from releases/v6.0.2.rst rename to docs/releases/v6.0.2.rst diff --git a/releases/v7.0.0.rst b/docs/releases/v7.0.0.rst similarity index 100% rename from releases/v7.0.0.rst rename to docs/releases/v7.0.0.rst diff --git a/releases/v7.0.1.rst b/docs/releases/v7.0.1.rst similarity index 100% rename from releases/v7.0.1.rst rename to docs/releases/v7.0.1.rst diff --git a/releases/v8.0.0.rst b/docs/releases/v8.0.0.rst similarity index 100% rename from releases/v8.0.0.rst rename to docs/releases/v8.0.0.rst diff --git a/releases/v9.0.0.rst b/docs/releases/v9.0.0.rst similarity index 100% rename from releases/v9.0.0.rst rename to docs/releases/v9.0.0.rst diff --git a/schema_cache.rst b/docs/schema_cache.rst similarity index 100% rename from schema_cache.rst rename to docs/schema_cache.rst diff --git a/schema_structure.rst b/docs/schema_structure.rst similarity index 100% rename from schema_structure.rst rename to docs/schema_structure.rst diff --git a/tutorials/tut0.rst b/docs/tutorials/tut0.rst similarity index 100% rename from tutorials/tut0.rst rename to docs/tutorials/tut0.rst diff --git a/tutorials/tut1.rst b/docs/tutorials/tut1.rst similarity index 100% rename from tutorials/tut1.rst rename to docs/tutorials/tut1.rst diff --git a/livereload_docs.py b/livereload_docs.py index 7674d11d3..5d0f5db2e 100755 --- 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/')