From c1c45060baeb439cd3b56cc79b831732cf4efb95 Mon Sep 17 00:00:00 2001 From: Wolfgang Walther Date: Sat, 17 Feb 2024 12:53:41 +0100 Subject: [PATCH] chore: Prepare merge of postgrest-docs into postgrest main repo This avoids some merge conflicts to allow git blame to detect renames properly. --- .github/workflows/{ci.yaml => docs.yaml} | 14 +++++++------- .readthedocs.yaml | 2 +- .gitignore => docs/.gitignore | 2 +- README.md => docs/README.md | 0 {diagrams => docs/_diagrams}/README.md | 4 ++-- {diagrams => docs/_diagrams}/boxoffice.er | 0 {diagrams => docs/_diagrams}/db.tex | 0 {diagrams => docs/_diagrams}/employees.er | 0 {diagrams => docs/_diagrams}/film.er | 0 {diagrams => docs/_diagrams}/orders.er | 0 {diagrams => docs/_diagrams}/premieres.er | 0 {diagrams => docs/_diagrams}/presidents.er | 0 {diagrams => docs/_diagrams}/users.er | 0 default.nix => docs/default.nix | 13 +++++++++---- .../extensions}/sphinx-copybutton.nix | 0 {extensions => docs/extensions}/sphinx-tabs.nix | 0 livereload_docs.py => docs/livereload_docs.py | 4 ++-- postgrest.dict => docs/postgrest.dict | 0 requirements.txt => docs/requirements.txt | 0 shell.nix => docs/shell.nix | 0 20 files changed, 22 insertions(+), 17 deletions(-) rename .github/workflows/{ci.yaml => docs.yaml} (77%) rename .gitignore => docs/.gitignore (79%) rename README.md => docs/README.md (100%) rename {diagrams => docs/_diagrams}/README.md (91%) rename {diagrams => docs/_diagrams}/boxoffice.er (100%) rename {diagrams => docs/_diagrams}/db.tex (100%) rename {diagrams => docs/_diagrams}/employees.er (100%) rename {diagrams => docs/_diagrams}/film.er (100%) rename {diagrams => docs/_diagrams}/orders.er (100%) rename {diagrams => docs/_diagrams}/premieres.er (100%) rename {diagrams => docs/_diagrams}/presidents.er (100%) rename {diagrams => docs/_diagrams}/users.er (100%) rename default.nix => docs/default.nix (79%) rename {extensions => docs/extensions}/sphinx-copybutton.nix (100%) rename {extensions => docs/extensions}/sphinx-tabs.nix (100%) rename livereload_docs.py => docs/livereload_docs.py (61%) rename postgrest.dict => docs/postgrest.dict (100%) rename requirements.txt => docs/requirements.txt (100%) rename shell.nix => docs/shell.nix (100%) diff --git a/.github/workflows/ci.yaml b/.github/workflows/docs.yaml similarity index 77% rename from .github/workflows/ci.yaml rename to .github/workflows/docs.yaml index 782b3eceb..f9bf2fd3a 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/docs.yaml @@ -1,14 +1,14 @@ -name: CI +name: Docs on: push: branches: - main - - v* + - rel-* pull_request: branches: - main - - v* + - rel-* jobs: build: @@ -17,7 +17,7 @@ jobs: steps: - uses: actions/checkout@v3 - uses: cachix/install-nix-action@v22 - - run: nix-env -f default.nix -iA build + - run: nix-env -f docs/default.nix -iA build - run: postgrest-docs-build spellcheck: @@ -26,7 +26,7 @@ jobs: steps: - uses: actions/checkout@v3 - uses: cachix/install-nix-action@v22 - - run: nix-env -f default.nix -iA spellcheck + - run: nix-env -f docs/default.nix -iA spellcheck - run: postgrest-docs-spellcheck dictcheck: @@ -35,7 +35,7 @@ jobs: steps: - uses: actions/checkout@v3 - uses: cachix/install-nix-action@v22 - - run: nix-env -f default.nix -iA dictcheck + - run: nix-env -f docs/default.nix -iA dictcheck - run: postgrest-docs-dictcheck linkcheck: @@ -45,6 +45,6 @@ jobs: steps: - uses: actions/checkout@v3 - uses: cachix/install-nix-action@v22 - - run: nix-env -f default.nix -iA linkcheck + - run: nix-env -f docs/default.nix -iA linkcheck - run: postgrest-docs-linkcheck diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 4690fde9d..0d7162c8f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -3,7 +3,7 @@ sphinx: configuration: docs/conf.py python: install: - - requirements: requirements.txt + - requirements: docs/requirements.txt build: os: ubuntu-22.04 tools: diff --git a/.gitignore b/docs/.gitignore similarity index 79% rename from .gitignore rename to docs/.gitignore index bab47b52e..503e5d524 100644 --- a/.gitignore +++ b/docs/.gitignore @@ -2,7 +2,7 @@ _build Pipfile.lock *.aux *.log -diagrams/db.pdf +_diagrams/db.pdf misspellings unuseddict .history diff --git a/README.md b/docs/README.md similarity index 100% rename from README.md rename to docs/README.md diff --git a/diagrams/README.md b/docs/_diagrams/README.md similarity index 91% rename from diagrams/README.md rename to docs/_diagrams/README.md index fa4a1e7fe..7014ae378 100644 --- a/diagrams/README.md +++ b/docs/_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 docs/_static/film.png +./erd_static-x86-64 -i film.er -o ../_static/film.png ``` The fonts used belong to the GNU FreeFont family. You can download them here: http://ftp.gnu.org/gnu/freefont/ @@ -20,7 +20,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 ../docs/_static/ +mv db.png ../_static/ ``` LaTeX is used because it's a tweakable plain text format. diff --git a/diagrams/boxoffice.er b/docs/_diagrams/boxoffice.er similarity index 100% rename from diagrams/boxoffice.er rename to docs/_diagrams/boxoffice.er diff --git a/diagrams/db.tex b/docs/_diagrams/db.tex similarity index 100% rename from diagrams/db.tex rename to docs/_diagrams/db.tex diff --git a/diagrams/employees.er b/docs/_diagrams/employees.er similarity index 100% rename from diagrams/employees.er rename to docs/_diagrams/employees.er diff --git a/diagrams/film.er b/docs/_diagrams/film.er similarity index 100% rename from diagrams/film.er rename to docs/_diagrams/film.er diff --git a/diagrams/orders.er b/docs/_diagrams/orders.er similarity index 100% rename from diagrams/orders.er rename to docs/_diagrams/orders.er diff --git a/diagrams/premieres.er b/docs/_diagrams/premieres.er similarity index 100% rename from diagrams/premieres.er rename to docs/_diagrams/premieres.er diff --git a/diagrams/presidents.er b/docs/_diagrams/presidents.er similarity index 100% rename from diagrams/presidents.er rename to docs/_diagrams/presidents.er diff --git a/diagrams/users.er b/docs/_diagrams/users.er similarity index 100% rename from diagrams/users.er rename to docs/_diagrams/users.er diff --git a/default.nix b/docs/default.nix similarity index 79% rename from default.nix rename to docs/default.nix index 42fbaca76..08f654e59 100644 --- a/default.nix +++ b/docs/default.nix @@ -27,17 +27,19 @@ in pkgs.writeShellScriptBin "postgrest-docs-build" '' set -euo pipefail + cd "$(${pkgs.git}/bin/git rev-parse --show-toplevel)/docs" # clean previous build, otherwise some errors might be supressed rm -rf _build - ${python}/bin/sphinx-build --color -W -b html -a -n docs _build + ${python}/bin/sphinx-build --color -W -b html -a -n . _build ''; serve = pkgs.writeShellScriptBin "postgrest-docs-serve" '' set -euo pipefail + cd "$(${pkgs.git}/bin/git rev-parse --show-toplevel)/docs" # livereload_docs.py needs to find "sphinx-build" PATH=${python}/bin:$PATH @@ -49,8 +51,9 @@ in pkgs.writeShellScriptBin "postgrest-docs-spellcheck" '' set -euo pipefail + cd "$(${pkgs.git}/bin/git rev-parse --show-toplevel)/docs" - FILES=$(find docs -type f -iname '*.rst' | tr '\n' ' ') + FILES=$(find . -type f -iname '*.rst' | tr '\n' ' ') cat $FILES \ | grep -v '^\(\.\.\| \)' \ @@ -66,8 +69,9 @@ in pkgs.writeShellScriptBin "postgrest-docs-dictcheck" '' set -euo pipefail + cd "$(${pkgs.git}/bin/git rev-parse --show-toplevel)/docs" - FILES=$(find docs -type f -iname '*.rst' | tr '\n' ' ') + FILES=$(find . -type f -iname '*.rst' | tr '\n' ' ') cat postgrest.dict \ | tail -n+2 \ @@ -82,7 +86,8 @@ in pkgs.writeShellScriptBin "postgrest-docs-linkcheck" '' set -euo pipefail + cd "$(${pkgs.git}/bin/git rev-parse --show-toplevel)/docs" - ${python}/bin/sphinx-build --color -b linkcheck docs _build + ${python}/bin/sphinx-build --color -b linkcheck . _build ''; } diff --git a/extensions/sphinx-copybutton.nix b/docs/extensions/sphinx-copybutton.nix similarity index 100% rename from extensions/sphinx-copybutton.nix rename to docs/extensions/sphinx-copybutton.nix diff --git a/extensions/sphinx-tabs.nix b/docs/extensions/sphinx-tabs.nix similarity index 100% rename from extensions/sphinx-tabs.nix rename to docs/extensions/sphinx-tabs.nix diff --git a/livereload_docs.py b/docs/livereload_docs.py similarity index 61% rename from livereload_docs.py rename to docs/livereload_docs.py index 8dae16577..741633d43 100755 --- a/livereload_docs.py +++ b/docs/livereload_docs.py @@ -2,9 +2,9 @@ from livereload import Server, shell from subprocess import call ## Build docs at startup -call(['sphinx-build', '-b', 'html', '-a', '-n', 'docs', '_build']) +call(['sphinx-build', '-b', 'html', '-a', '-n', '.', '_build']) server = Server() -server.watch('docs/**/*.rst', shell('sphinx-build -b html -a -n docs _build')) +server.watch('**/*.rst', shell('sphinx-build -b html -a -n . _build')) # For custom port and host # server.serve(root='_build/', host='192.168.1.2') server.serve(root='_build/') diff --git a/postgrest.dict b/docs/postgrest.dict similarity index 100% rename from postgrest.dict rename to docs/postgrest.dict diff --git a/requirements.txt b/docs/requirements.txt similarity index 100% rename from requirements.txt rename to docs/requirements.txt diff --git a/shell.nix b/docs/shell.nix similarity index 100% rename from shell.nix rename to docs/shell.nix