aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/.pages1
-rw-r--r--docs/README.md9
-rw-r--r--docs/README.pt.md10
-rw-r--r--docs/contact/.pages1
-rw-r--r--docs/flavors/CC-BY-4.0-FAI.en.md9
-rw-r--r--docs/flavors/CC-BY-4.0-FAI.pt.md9
-rw-r--r--docs/flavors/CC-BY-SA-4.0-FAI.en.md9
-rw-r--r--docs/flavors/CC-BY-SA-4.0-FAI.pt.md10
-rw-r--r--docs/help/.pages1
-rw-r--r--docs/how/.pages1
-rw-r--r--docs/references/.pages1
-rw-r--r--docs/why/.pages1
-rw-r--r--docs/why/README.md4
-rw-r--r--docs/why/README.pt.md5
-rw-r--r--mkdocs.yml27
-rwxr-xr-xscripts/provision2
16 files changed, 81 insertions, 19 deletions
diff --git a/docs/.pages b/docs/.pages
index 760a24b..c9443e1 100644
--- a/docs/.pages
+++ b/docs/.pages
@@ -2,6 +2,7 @@ nav:
- README.md
- README.pt.md
- why
+ - flavors
#- how
- references
#- help
diff --git a/docs/README.md b/docs/README.md
index db4bf4c..d7ff7be 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -9,13 +9,10 @@ Copy Far "AI" - A [copyleft][] license, but far from the so-called
Use and adapt this license as necessary:
-> Copy Far "AI" - v0.0.1 - Copyleft license far from the so-called
-> "Artificial Intelligences" - https://copyfarai.itcouldbewor.se
+> {{ config.site_name }} - v0.0.1 - {{ slogan.en }} -
+> {{ base_url }}
>
-> This work, in the present or previous versions, cannot be used for
-> procedures known as "machine learning" and stylometric analysis
-> without the previous authorization. For all other uses, this
-> version is available under the License `$license`.
+> {{ licenses.v0_0_1.en }} `$license`
Where `$license` is any other license, such as [CC BY 4.0][].
diff --git a/docs/README.pt.md b/docs/README.pt.md
index 2edcc4b..3ea0d10 100644
--- a/docs/README.pt.md
+++ b/docs/README.pt.md
@@ -9,14 +9,10 @@ Artificiais".
Use esta licença e adapte-a conforme necessário:
-> Copy Far "AI" - v0.0.1 - Licença copyleft longe das ditas
-> "Inteligências Artificiais" - https://copyfarai.itcouldbewor.se/pt
+> {{ config.site_name }} - v0.0.1 - {{ slogan.pt }} -
+> {{ base_url }}/pt
>
-> Esta obra, na presente versão assim como nas anteriores, não pode
-> ser usada para procedimentos conhecidos como "treinamento ou
-> aprendizado de máquina" e análise estilométrica sem a prévia
-> autorização. Para todos os outros meios e fins, esta versão está
-> disponível sob a Licença $license.
+> {{ licenses.v0_0_1.pt }} `$license`
Onde `$license` é qualquer outra licença, como [CC BY 4.0][].
diff --git a/docs/contact/.pages b/docs/contact/.pages
new file mode 100644
index 0000000..fbd7cce
--- /dev/null
+++ b/docs/contact/.pages
@@ -0,0 +1 @@
+collapse: true
diff --git a/docs/flavors/CC-BY-4.0-FAI.en.md b/docs/flavors/CC-BY-4.0-FAI.en.md
new file mode 100644
index 0000000..d1ae5f0
--- /dev/null
+++ b/docs/flavors/CC-BY-4.0-FAI.en.md
@@ -0,0 +1,9 @@
+# CC BY 4.0 FAI
+
+> {{ config.site_name }} - v0.0.1 - {{ slogan.en }} -
+> {{ base_url }}/flavors/CC-BY-4.0-FAI/
+>
+> {{ licenses.v0_0_1.en }} Creative Commons Attribution 4.0 International ([CC
+> BY 4.0][]).
+
+[CC BY 4.0]: https://creativecommons.org/licenses/by/4.0/
diff --git a/docs/flavors/CC-BY-4.0-FAI.pt.md b/docs/flavors/CC-BY-4.0-FAI.pt.md
new file mode 100644
index 0000000..6715b49
--- /dev/null
+++ b/docs/flavors/CC-BY-4.0-FAI.pt.md
@@ -0,0 +1,9 @@
+# CC BY 4.0 FAI
+
+> {{ config.site_name }} - v0.0.1 - {{ slogan.pt }} -
+> {{ base_url }}/pt/flavors/CC-BY-4.0-FAI
+>
+> {{ licenses.v0_0_1.pt }} Creative Commons -
+> Atribuição-NãoComercial-CompartilhaIgual 4.0 Internacional ([CC BY 4.0][]).
+
+[CC BY 4.0]: https://creativecommons.org/licenses/by/4.0/deed.pt_BR
diff --git a/docs/flavors/CC-BY-SA-4.0-FAI.en.md b/docs/flavors/CC-BY-SA-4.0-FAI.en.md
new file mode 100644
index 0000000..c4cee1d
--- /dev/null
+++ b/docs/flavors/CC-BY-SA-4.0-FAI.en.md
@@ -0,0 +1,9 @@
+# CC BY SA 4.0 FAI
+
+> {{ config.site_name }} - v0.0.1 - {{ slogan.en }} -
+> {{ base_url }}/flavors/CC-BY-SA-4.0-FAI/
+>
+> {{ licenses.v0_0_1.en }} Creative Commons Attribution-ShareAlike 4.0
+> International ([CC BY SA 4.0][]).
+
+[CC BY SA 4.0]: https://creativecommons.org/licenses/by-sa/4.0/
diff --git a/docs/flavors/CC-BY-SA-4.0-FAI.pt.md b/docs/flavors/CC-BY-SA-4.0-FAI.pt.md
new file mode 100644
index 0000000..59d96ab
--- /dev/null
+++ b/docs/flavors/CC-BY-SA-4.0-FAI.pt.md
@@ -0,0 +1,10 @@
+# CC BY SA 4.0 FAI
+
+> {{ config.site_name }} - v0.0.1 - {{ slogan.pt }} -
+> {{ base_url }}/pt/flavors/CC-BY-SA-4.0-FAI
+>
+> {{ licenses.v0_0_1.pt }} Creative Commons -
+> Atribuição-NãoComercial-CompartilhaIgual 4.0 Internacional ([CC BY SA
+> 4.0][]).
+
+[CC BY SA 4.0]: https://creativecommons.org/licenses/by-sa/4.0/deed.pt_BR
diff --git a/docs/help/.pages b/docs/help/.pages
new file mode 100644
index 0000000..fbd7cce
--- /dev/null
+++ b/docs/help/.pages
@@ -0,0 +1 @@
+collapse: true
diff --git a/docs/how/.pages b/docs/how/.pages
new file mode 100644
index 0000000..fbd7cce
--- /dev/null
+++ b/docs/how/.pages
@@ -0,0 +1 @@
+collapse: true
diff --git a/docs/references/.pages b/docs/references/.pages
new file mode 100644
index 0000000..fbd7cce
--- /dev/null
+++ b/docs/references/.pages
@@ -0,0 +1 @@
+collapse: true
diff --git a/docs/why/.pages b/docs/why/.pages
new file mode 100644
index 0000000..fbd7cce
--- /dev/null
+++ b/docs/why/.pages
@@ -0,0 +1 @@
+collapse: true
diff --git a/docs/why/README.md b/docs/why/README.md
index 9a7d9aa..7b82699 100644
--- a/docs/why/README.md
+++ b/docs/why/README.md
@@ -3,8 +3,8 @@
This project was created to supply the absence of specific licenses that
restricts ingestion of content in some system such as [LLMs][].
-Besides existing [discussions](/references) about non-licensing for [LLMs][] and
-such, there was no specific and easily usable license.
+Besides existing [discussions](../references/README.md) about non-licensing for
+[LLMs][] and such, there was no specific and easily usable license.
Then, a disclaimer was created to be plugged in any existing license.
diff --git a/docs/why/README.pt.md b/docs/why/README.pt.md
index 1f6baee..481ea5a 100644
--- a/docs/why/README.pt.md
+++ b/docs/why/README.pt.md
@@ -3,8 +3,9 @@
Este projeto surgiu para suprir a ausência de licenças específicas que
restrinjam a ingestão de obras em determinados sistemas, como [LLMs][].
-Apesar de existirem [discussões](/references) sobre não-licenciamento de
-conteúdo para [LLMs][] e afins, não havia uma licença específica e facilmente usável.
+Apesar de existirem [discussões](../references/README.md) sobre
+não-licenciamento de conteúdo para [LLMs][] e afins, não havia uma licença
+específica e facilmente usável.
Por isso, um disclaimer foi redigido pra encaixar em qualquer licença
existente.
diff --git a/mkdocs.yml b/mkdocs.yml
index db44c03..8c46302 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -44,9 +44,11 @@ extra_css:
plugins:
#- search
+ - macros
+
- awesome-pages:
strict: false
- collapse_single_pages: true
+ #collapse_single_pages: true
- i18n:
docs_structure: suffix
@@ -58,6 +60,8 @@ plugins:
- locale: pt
name: Português
build: true
+ nav_translations:
+ Flavors: Sabores
markdown_extensions:
- footnotes
@@ -66,3 +70,24 @@ copyright: Copy Far "AI" © 2023+
extra:
generator: false
+
+ base_url: https://copyfarai.itcouldbewor.se
+
+ slogan:
+ en: Copyleft license far from the so-called "Artificial Intelligences"
+ pt: Licença copyleft longe das ditas "Inteligências Artificiais"
+
+ licenses:
+ v0_0_1:
+ en: >
+ This work, in the present or previous versions, cannot be used for
+ procedures known as "machine learning" and stylometric analysis
+ without the previous authorization. For all other uses, this
+ version is available under the License
+
+ pt: >
+ Esta obra, na presente versão assim como nas anteriores, não pode
+ ser usada para procedimentos conhecidos como "treinamento ou
+ aprendizado de máquina" e análise estilométrica sem a prévia
+ autorização. Para todos os outros meios e fins, esta versão está
+ disponível sob a Licença
diff --git a/scripts/provision b/scripts/provision
index c6916de..b4fe532 100755
--- a/scripts/provision
+++ b/scripts/provision
@@ -10,7 +10,7 @@ DIRNAME="`dirname $0`"
DEPENDENCIES="mkdocs apache2 python3-pip pandoc pandoc-citeproc"
# PyPI dependencies
-DEPENDENCIES_PIP="mkdocs-bibtex mkdocs-material mkdocs-awesome-pages-plugin mkdocs-static-i18n"
+DEPENDENCIES_PIP="mkdocs-bibtex mkdocs-material mkdocs-awesome-pages-plugin mkdocs-static-i18n mkdocs-macros-plugin"
# Check for sudo
if [ "`whoami`" != "root" ]; then