prepare release of the doc

webu · Sep 13, 2023 · fa0c96d · fa0c96d
1 parent 2d1355a
commit fa0c96d
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,7 @@ __pycache__
 /*.egg/
 /.cache/
 /.pytest_cache/
+docs/.venv/
 docs/venv/
 docs/build/
 wagtail_parler.sqlite
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,24 @@
+Copyright 2023 Webu
+
+Redistribution and use in source and binary forms, with or without modification, are permitted
+provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of
+   conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of
+   conditions and the following disclaimer in the documentation and/or other materials provided
+   with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to
+   endorse or promote products derived from this software without specific prior written
+   permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
+WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
@@ -104,7 +104,7 @@ modeladmin_register(FoodAdmin)
 
 ## Extra 🧀🐦
 
-More advanced usage, tests, etc., are documented [in the doc](https://readthedocs.org/projects/wagtail-parler/badge/?version=latest).
+More advanced usage, tests, etc., are documented [in the doc](https://wagtail-parler.readthedocs.io/).
 
 > Maître [Wagtail][wagtail], sur un arbre perché,  
 > Tenait en son bec une omelette du fromage.  

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
 sphinx
 sphinx_rtd_theme
 myst_parser
-django
+-e ./
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -9,7 +9,6 @@
 
 # Standard libs
 import os
-import sys
 
 # Django imports
 import django
@@ -18,8 +17,7 @@
 # wagtail / parler
 from wagtail_parler import __version__ as wagtail_parler_version
 
-sys.path.insert(0, os.path.abspath("../.."))
-os.environ["DJANGO_SETTINGS_MODULE"] = "tests.settings"
+os.environ["DJANGO_SETTINGS_MODULE"] = "wagtail_parler_tests.settings"
 django.setup()
 
 

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -1,8 +1,8 @@
-# Wagtail Parler
-
+```{include} presentation.md
+```
 ```{toctree}
 :maxdepth: 2
-wagtail_parler
+presentation
 configuration
 usage
 ```
diff --git a/docs/source/wmp.md → docs/source/presentation.md b/docs/source/wmp.md → docs/source/presentation.md