Fixes documentation (#3)

Co-authored-by: Adam Puza <[email protected]>
adamhmetal · Feb 4, 2024 · fff34a1 · fff34a1
1 parent 687930b
commit fff34a1
Show file tree

Hide file tree

Showing 32 changed files with 100 additions and 73 deletions.
diff --git a/README.md b/README.md
@@ -8,14 +8,14 @@ The idea of RedBeanPython ORM is to decrease the time to market for applications
 
 RedBeanPython ORM's idea is not to replace the more advanced ORMs (we should not reinvent the wheel) but to cooperate with them. Initially, it can be used as only ORM. When projects evolve, both code bases (RedBeanPython and SQLAlchemy) can coexist and, finally, can be swiftly replaced by SQLAlchemy (if needed).
 
-![Tests on PostgreSQL](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_postgres.yml/badge.svg) 
-![Tests on MySQL](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_mysql.yml/badge.svg) 
-![Tests on SQLite](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_sqlite.yml/badge.svg)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=coverage)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
-
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
-[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
-[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
+![Tests on PostgreSQL](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_postgres.yml/badge.svg) 
+![Tests on MySQL](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_mysql.yml/badge.svg) 
+![Tests on SQLite](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_sqlite.yml/badge.svg)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=coverage)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
 
 
 # Installation

diff --git a/dist/redbeanpython-1.0.0-py3-none-any.whl b/dist/redbeanpython-1.0.0-py3-none-any.whl
diff --git a/dist/redbeanpython-1.0.0.tar.gz b/dist/redbeanpython-1.0.0.tar.gz
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.0.1
+
+2021-02-04
+
+Documentation fixes.
+
 ## 1.0.0
 
 2021-02-01

diff --git a/docs/index.md b/docs/index.md
@@ -11,14 +11,14 @@ RedBeanPython idea is inspired by the matured [RedBeanPHP ORM](https://www.redbe
 
 RedBeanPython ORM's idea is not to replace the more advanced ORMs (we should not reinvent the wheel) but to cooperate with them. Initially, it can be used as only ORM. When projects evolve, both code bases (RedBeanPython and SQLAlchemy) can coexist and, finally, can be swiftly replaced by SQLAlchemy (if needed).
 
-![Tests on PostgreSQL](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_postgres.yml/badge.svg) 
-![Tests on MySQL](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_mysql.yml/badge.svg) 
-![Tests on SQLite](https://github.com/adamhmetal/redbeanpythondev/actions/workflows/test_sqlite.yml/badge.svg)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=coverage)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
-
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
-[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
-[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpythondev&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpythondev)
+![Tests on PostgreSQL](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_postgres.yml/badge.svg) 
+![Tests on MySQL](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_mysql.yml/badge.svg) 
+![Tests on SQLite](https://github.com/adamhmetal/redbeanpython/actions/workflows/test_sqlite.yml/badge.svg)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=coverage)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=adamhmetal_redbeanpython&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=adamhmetal_redbeanpython)
 
 
 ## Let's see an example of a usual project lifecycle.

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "redbeanpython"
-version = "1.0.0"
+version = "1.0.1"
 description = "RedBeanPython ORM"
 authors = ["Adam Puza <[email protected]>"]
 readme = "README.md"

diff --git a/site/404.html b/site/404.html
@@ -16,7 +16,7 @@
 
 
       <link rel="icon" href="/assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -956,7 +956,7 @@ <h1>404 - Not found</h1>
     <script id="__config" type="application/json">{"base": "/", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="/assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="/assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>

diff --git a/...assets/javascripts/bundle.c18c5fb9.min.js → ...assets/javascripts/bundle.e1c3ead8.min.js b/...assets/javascripts/bundle.c18c5fb9.min.js → ...assets/javascripts/bundle.e1c3ead8.min.js
diff --git a/...ts/javascripts/bundle.c18c5fb9.min.js.map → ...ts/javascripts/bundle.e1c3ead8.min.js.map b/...ts/javascripts/bundle.c18c5fb9.min.js.map → ...ts/javascripts/bundle.e1c3ead8.min.js.map
diff --git a/site/beans/index.html b/site/beans/index.html
@@ -22,7 +22,7 @@
 
 
       <link rel="icon" href="../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -1181,7 +1181,7 @@ <h1 id="___">___</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>

diff --git a/site/bulk_operations/index.html b/site/bulk_operations/index.html
@@ -22,7 +22,7 @@
 
 
       <link rel="icon" href="../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -1105,7 +1105,7 @@ <h1 id="___">___</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>

diff --git a/site/changelog/index.html b/site/changelog/index.html
@@ -22,7 +22,7 @@
 
 
       <link rel="icon" href="../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -879,6 +879,15 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#101" class="md-nav__link">
+    <span class="md-ellipsis">
+      1.0.1
+    </span>
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#100" class="md-nav__link">
     <span class="md-ellipsis">
@@ -972,6 +981,15 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#101" class="md-nav__link">
+    <span class="md-ellipsis">
+      1.0.1
+    </span>
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#100" class="md-nav__link">
     <span class="md-ellipsis">
@@ -997,6 +1015,9 @@
 
 
 <h1 id="changelog">Changelog</h1>
+<h2 id="101">1.0.1</h2>
+<p>2021-02-04</p>
+<p>Documentation fixes.</p>
 <h2 id="100">1.0.0</h2>
 <p>2021-02-01</p>
 <p>First release (production-ready).</p>
@@ -1055,7 +1076,7 @@ <h1 id="___">___</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>

diff --git a/site/connection/index.html b/site/connection/index.html
@@ -22,7 +22,7 @@
 
 
       <link rel="icon" href="../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -1068,7 +1068,7 @@ <h1 id="___">___</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>

diff --git a/site/conventions/index.html b/site/conventions/index.html
@@ -22,7 +22,7 @@
 
 
       <link rel="icon" href="../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -1177,7 +1177,7 @@ <h1 id="___">___</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>

diff --git a/site/crud/index.html b/site/crud/index.html
@@ -22,7 +22,7 @@
 
 
       <link rel="icon" href="../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -1087,7 +1087,7 @@ <h1 id="___">___</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>

diff --git a/site/custom_configuration/index.html b/site/custom_configuration/index.html
@@ -22,7 +22,7 @@
 
 
       <link rel="icon" href="../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -1013,7 +1013,7 @@ <h1 id="___">___</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>

diff --git a/site/finding/index.html b/site/finding/index.html
@@ -22,7 +22,7 @@
 
 
       <link rel="icon" href="../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -1227,7 +1227,7 @@ <h1 id="___">___</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>

diff --git a/site/fluid_frozen/index.html b/site/fluid_frozen/index.html
@@ -22,7 +22,7 @@
 
 
       <link rel="icon" href="../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -1026,7 +1026,7 @@ <h1 id="___">___</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>

diff --git a/site/hybrid_mode/index.html b/site/hybrid_mode/index.html
@@ -22,7 +22,7 @@
 
 
       <link rel="icon" href="../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.5">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.6">
 
 
 
@@ -1037,7 +1037,7 @@ <h1 id="___">___</h1>
     <script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.expand"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../assets/javascripts/bundle.c18c5fb9.min.js"></script>
+      <script src="../assets/javascripts/bundle.e1c3ead8.min.js"></script>
 
 
   </body>