uEdition 0.9.0__tar.gz → 1.0.0__tar.gz

{uedition-0.9.0 → uedition-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uEdition
-Version: 0.9.0
+Version: 1.0.0
 Project-URL: Documentation, https://github.com/uEdition/uEdition#readme
 Project-URL: Issues, https://github.com/uEdition/uEdition/issues
 Project-URL: Source, https://github.com/uEdition/uEdition
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
 Requires-Dist: copier<10.0.0,>=9.0.0
-Requires-Dist: jupyter-book<1.0.0,>=0.15.1
+Requires-Dist: jupyter-book<2.0.0,>=1.0.0
 Requires-Dist: livereload
 Requires-Dist: lxml<6.0.0,>=4.9.2
 Requires-Dist: pydantic-settings<3.0.0,>=2.0.0
@@ -48,6 +48,16 @@ The recommended installation for use is via `pipx`:
 pipx install uedition
 ```
 
+All commands can then be run via
+
+```console
+uEdition {command}
+```
+
+## Documentation
+
+Full documentation is available at [https://uedition.readthedocs.io](https://uedition.readthedocs.io).
+
 ## License
 
-`uedition` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+The μEdition is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

{uedition-0.9.0 → uedition-1.0.0}/README.md

@@ -22,6 +22,16 @@ The recommended installation for use is via `pipx`:
 pipx install uedition
 ```
 
+All commands can then be run via
+
+```console
+uEdition {command}
+```
+
+## Documentation
+
+Full documentation is available at [https://uedition.readthedocs.io](https://uedition.readthedocs.io).
+
 ## License
 
-`uedition` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+The μEdition is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

uedition-1.0.0/docs/.readthedocs.yml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  commands:
+    - "pip install hatch"
+    - "hatch run build"
+    - "mkdir $READTHEDOCS_OUTPUT"
+    - "mv site $READTHEDOCS_OUTPUT/html"
+
+python:
+  install:
+    - method: pip
+      path: .

{uedition-0.9.0 → uedition-1.0.0}/docs/.uEdition.answers

@@ -1,9 +1,9 @@
 # Changes here will be overwritten by Copier
-_commit: v0.0.11-2-gf9997e6
-_src_path: ../uEdition-project-template/
+_commit: v0.1.8
+_src_path: gh:uEdition/uEdition-project-template
 author_email: mark.hall@work.room3b.eu
 author_name: Mark Hall
 edition_name: μEdition
-publishing: ''
+publishing: readthedocs
 repository_branch: main
 repository_url: https://github.com/uEdition/uEdition

uedition-1.0.0/docs/de/changelog.md

@@ -0,0 +1,72 @@
+# Änderungsgeschichte
+
+## 1.0.0 (31.01.2024)
+
+* **Neu**: TEI Output ist optional
+* **Aktualisiert**: JupyterBook auf Version 1 aktualisert
+* **Aktualisert**: Sprachwechsler wird nicht angezeigt, wenn nur eine Sprache konfiguriert ist
+* **Bugfix**: Einen Bug im Ausgabepfadname korrigiert
+* **Bugfix**: Einen Bug im Sprachwechsler behoben
+
+## 0.9.0 (26.01.2024)
+
+* **Neu**: TEI Output hinzugefügt
+* **Aktualisiert**: Bereits beantwortet Fragen überspringen
+
+## 0.8.0 (12.01.2024)
+
+* **Neu**: Unterstützung von Read the Docs als Publikationsplatform
+* **Bugfix**: Softwareabhängigkeiten aktualisiert
+
+## 0.7.0 (04.07.2023)
+
+* **Neu**: Unterstützung für zentrale, statische Dateien
+* **Bugfix**: Fehlende Fortschrittsanzeige hinzugefügt
+
+## 0.6.1 (04.07.2023)
+
+* **Aktualisiert**: Softwareabhängigkeiten aktualisiert
+
+## 0.6.0 (04.07.2023)
+
+* **Neu**: Zentrale Konfiguration und Inhaltsverzeichnis
+
+## 0.5.0 (30.06.2023)
+
+* **Neu**: Copier in die uEdition integriert
+
+## 0.4.0 (26.06.2023)
+
+* **Neu**: Sprachwechsler hinzugefügt
+
+## 0.3.1 (22.06.2023)
+
+* **Bugfix**: Sicherstellen dass der Ausgabepfad existiert
+
+## 0.3.0 (22.06.2023)
+
+* **Neu**: Startseite mit automatischer Spracherkennung integriert
+
+## 0.2.1 (16.06.2023)
+
+* **Bugfix**: Abschnittsformatierungsbug behoben
+
+## 0.2.0 (16.06.2023)
+
+* **Neu**: Das TEI Layout auf vertikal umgestellt
+
+## 0.1.0 (13.06.2023)
+
+* **Neu**: TEI Input hinzugefügt
+
+## 0.0.3 (17.05.2023)
+
+* **Bugfix**: Korrektur im Softwarepublikationsprozess
+
+## 0.0.2 (17.05.2023)
+
+* **Bugfix**: Ausgabepfad korrekt handhaben
+
+## 0.0.1 (17.05.2023)
+
+* **Neu**: Erste Version

{uedition-0.9.0/docs/en → uedition-1.0.0/docs/de}/user/content.md

@@ -1,12 +1,11 @@
-# Writing Content
-
-The μEdition uses [Jupyter Book](https://jupyterbook.org) as its underlying technology for turning your text into a
-publishable website. Each language in the μEdition is a separate Jupyter Book and the μEdition provides the glue that
-merges the individual outputs together into a single site. This is achieved by moving the Jupyter Book configuration
-into shared configuration files. When the μEdition builds the final website, language-specific versions of the
-configurations are added to each language-specific Jupyter Book, before the Jupyter Book build process is then run
-for each language. Due to this structure, most of the guidance that the Jupyter Book project provides for writing
-and configuring Jupyter Book projects can be used in the μEdition.
+# Inhalte hinzufügen
+
+Die μEdition nutzt [Jupyter Book](https://jupyterbook.org) um aus den Inhalten eine Webseite zu generieren,
+welche dann veröffentlicht werden kann. Wenn die Webseite generiert wird, generiert die μEdition zuerst die
+Webseiten für die einzelnen Sprachen und fügt dann die notwendigen Element hinzu um die einzelnen Sprachen
+zusammenzufügen. Da die μEdition auf dem Jupyter Book aufbaut, sind der Großteil der Dokumentation des
+Jupyter Book Projekts auch für die μEdition nutzbar. Der einzige Unterschied ist, dass die μEdition eine
+Konfigurationsdatei und ein Inhaltsverzeichnisse für alle Sprachen nutzt.
 
 ## Structuring the μEdition
 

uedition-1.0.0/docs/de/user/create.md

@@ -0,0 +1,15 @@
+# Eine μEdition erstellen
+
+Jetzt wo alle Vorraussetzungen installiert sind, kann die erste μEdition erstellt werden. Auf der Kommandozeile
+navigieren sie in den Ordner in dem die μEdition erstellt werden soll und führen sie folgenden Befehl aus:
+
+:::{code-block} console
+$ copier copy gh:uEdition/uEdition-project-template my-edition
+:::
+
+Ersetzen sie `my-edition` mit dem Ordernamen in dem die μEdition erstellt werden soll. Der Installationsvorgang
+wird eine Reihe an Fragen stellen, um die neue μEdition zu konfigurieren und dann das μEditionsskeleton in dem
+Ordern erzeugen.
+
+Navigieren sie danach auf der Kommandozeile in den neuen Ordern und führen alle weiteren Befehle innerhalb des
+Ordners aus.

uedition-1.0.0/docs/de/user/index.md

@@ -0,0 +1,8 @@
+# Anleitung für Nutzer und Nutzerinnen
+
+Willkommen in der Nutzeranleitung für die μEdition, welche die Herausgeber durch die Abläufe zum
+{doc}`Erstellen einer neuen μEdition <create>`, {doc}`hinzufügen einer Sprache <language-add>`,
+{doc}`Erstellung von Inhalten <content>` und {doc}`Veröffentlichen mittels GitHub Pages <publish>` führt.
+
+Die Anleitung erwartet keine großen, technischen Vorkenntnisse, ausser Grundkenntnisse über die Nutzung der
+Kommandozeile. Zusätzlich werden für die Veröffentlichung über GitHub Pages grundlegende Git Kenntnisse benötigt.

uedition-1.0.0/docs/de/user/installation.md

@@ -0,0 +1,37 @@
+# Installation
+
+Die μEdition baut auf einer Reihe von Werkzeugen auf und um die erste μEdition zu erstellen, müssen diese Werkzeuge
+installiert werden.
+
+Die μEdition nutzt Python und unterstützt Versionen 3.10 und 3.11 [^python-version]. Bitte
+[installieren sie die Python Version für ihr Betriebssystem](https://python.org/downloads).
+
+Für die Erstellung einer μEdition wird ein Werkzeug namens [Copier](https://copier.readthedocs.io/en/stable/) genutzt.
+Für die Installation aller weiteren Abhängigkeiten und um die verschiedenen μEdition Funktionen aufzurufen wird
+[Hatch](https://hatch.pypa.io) genutzt.
+
+Die einfachste Weise um beide zu installieren ist mittels [pipx](https://pypa.github.io/pipx/), welches
+[von hier installiert werden kann](https://pypa.github.io/pipx/installation/). Nach der pipx installation nutzen sie
+die folgenden zwei Befehle um Copier und Hatch zu installieren:
+
+:::{code} console
+$ pipx install copier
+$ pipx install hatch
+:::
+
+Um zu überprüfen, dass die Installationen erfolgreich waren, nutzen sie die folgenden Befehle:
+
+:::{code} console
+$ copier
+$ hatch
+:::
+
+Wenn beide Befehle eine Zusammenfassung der verfügbaren Optionen und Befehle für die zwei Werkzeuge anzeigen, dann
+sind beide Werkzeuge korrekt installiert.
+
+Um im Team zusammenzuarbeiten und für die GitHub Pages Veröffentlichungsfunktionalität, muss auch das Versionskontrollwerkzeug
+[Git](https://git-scm.com/downloads) installiert sein. Eine vollständige Einführung in Git übersteigt den Platz hier,
+aber es gibt viele gute Tutorials im Netz und die [offizielle Dokumentation](https://git-scm.com/doc) ist auch hilfreich.
+
+[^python-version]: The μEdition wird mit Python 3.10 and 3.11 getested. Die μEdition funktioniert möglicherweise auch mit
+  neueren Python Versionen, ist aber auf diesen noch nicht getestet worden.

uedition-1.0.0/docs/de/user/language-add.md

@@ -0,0 +1,14 @@
+# Eine Sprache hinzufügen
+
+In der μEdition ist Mehrsprachigkeit eine Kernfunktionalität. Das bedeutet, dass selbst wenn die Edition nur in einer
+einzigen Sprache veröffentlicht werden soll, diese Sprache trotzdem explizit konfiguriert werden muss.
+
+Um der μEdition eine Sprache hinzuzufügen, führen sie folgenden Befehl aus:
+
+:::{code-block} console
+$ hatch run uEdition language add ORDERNAME
+:::
+
+Ersetzen sie `ORDNERNAME` mit dem Namen des Orderners in dem die Inhalte in der Sprache gespeichert werden. Der Vorgang
+wird ein paar Detailfragen zu der neuen Sprache abfragen und dann ein Inhaltsskelet in dem Ordern erzeugen, welches
+dann bereit ist um ediert zu werden.

uedition-1.0.0/docs/en/changelog.md

@@ -0,0 +1,72 @@
+# Changelog
+
+## 1.0.0 (31.01.2024)
+
+* **New**: TEI output optional
+* **Update**: JupyterBook updated to version 1
+* **Update**: Hide the language switcher when only one language is configured
+* **Bugfix**: Fix a bug in the output path naming
+* **Bugfix**: fixed a bug in the language switcher
+
+## 0.9.0 (26.01.2024)
+
+* **New**: Add TEI Output
+* **Update**: Skip previously answered questions
+
+## 0.8.0 (12.01.2024)
+
+* **New**: Support publishing via Read the Docs
+* **Bugfix**: Dependency updates
+
+## 0.7.0 (04.07.2023)
+
+* **New**: Support shared static files
+* **Bugfix**: Added missing progress update
+
+## 0.6.1 (04.07.2023)
+
+* **Update**: Compatability updates
+
+## 0.6.0 (04.07.2023)
+
+* **New**: Move to a shared central configuration and TOC
+
+## 0.5.0 (30.06.2023)
+
+* **New**: Directly integrate copier
+
+## 0.4.0 (26.06.2023)
+
+* **New**: Added the language switcher extension
+
+## 0.3.1 (22.06.2023)
+
+* **Bugfix**: Ensure that the output folder exists
+
+## 0.3.0 (22.06.2023)
+
+* **New**: Add a language-detecting landing page
+
+## 0.2.1 (16.06.2023)
+
+* **Bugfix**: Fix a section-wrapping bug
+
+## 0.2.0 (16.06.2023)
+
+* **New**: Switch the TEI layout to a vertical structure
+
+## 0.1.0 (13.06.2023)
+
+* **New**: Added basic TEI parsing
+
+## 0.0.3 (17.05.2023)
+
+* **Bugfix**: Fix the release process
+
+## 0.0.2 (17.05.2023)
+
+* **Bugfix**: Fix output path handling
+
+## 0.0.1 (17.05.2023)
+
+* **New**: Initial release

{uedition-0.9.0 → uedition-1.0.0}/docs/en/user/create.md

@@ -4,7 +4,7 @@ With all the pre-requisites installed correctly, you are now ready to create you
 navigate to the folder where you want to create your μEdition and run:
 
 :::{code-block} console
-$ copier copy https://github.com/uEdition/uEdition-project-template my-edition
+$ copier copy gh:uEdition/uEdition-project-template my-edition
 :::
 
 Replace `my-edition` with the name of the folder you want your edition to be created in. The setup process will ask

{uedition-0.9.0/docs/de → uedition-1.0.0/docs/en}/user/installation.md

@@ -12,7 +12,7 @@ is used.
 
 The easiest way to install both Copier and Hatch is via [pipx](https://pypa.github.io/pipx/), which you can
 [install from here](https://pypa.github.io/pipx/installation/). When you have pipx installed, then on the commandline
-run the following command to install Copier:
+run the following command to install Copier and Hatch:
 
 :::{code} console
 $ pipx install copier

uedition-1.0.0/docs/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "uedition_docs"
+description = 'The μEdition Documentation'
+requires-python = ">=3.10"
+keywords = []
+authors = [{ name = "Mark Hall", email = "mark.hall@work.room3b.eu" }]
+classifiers = []
+dependencies = []
+version = "1.0.0"
+
+[project.urls]
+Documentation = "https://github.com/uEdition/uEdition/-#readme"
+Issues = "https://github.com/uEdition/uEdition/-/issues"
+Source = "https://github.com/uEdition/uEdition/-"
+
+[tool.hatch.envs.default]
+dependencies = ["uedition>=0.9.0",]
+skip-install = true
+
+[tool.hatch.envs.default.scripts]
+build = "uEdition build {args}"
+serve = "uEdition serve {args}"
+update = "uEdition update {args}"

{uedition-0.9.0 → uedition-1.0.0}/docs/toc.yml

@@ -11,3 +11,4 @@ chapters:
       - file: user/publish
       - file: user/update
       - file: user/language-update
+  - file: changelog

{uedition-0.9.0 → uedition-1.0.0}/pyproject.toml

@@ -20,7 +20,7 @@ classifiers = [
 ]
 dependencies = [
   "copier>=9.0.0,<10.0.0",
-  "jupyter-book>=0.15.1,<1.0.0",
+  "jupyter-book>=1.0.0,<2.0.0",
   "lxml>=4.9.2,<6.0.0",
   "livereload",
   "pydantic>=2.0.0,<3.0.0",

{uedition-0.9.0 → uedition-1.0.0}/uedition/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Dev
+
+* **New**: Add a switch to turn off the TEI generation
+* **Update**: Don't enable the language switcher when only one language is configured
+* **Bugfix**: Fixed a bug in the TEI generation
+* **Bugfix**: Fixed the builder output paths
+
 ## 0.9.0
 
 * **New**: Added TEI output

{uedition-0.9.0 → uedition-1.0.0}/uedition/__about__.py

@@ -2,4 +2,4 @@
 #
 # SPDX-License-Identifier: MIT
 """About this package."""
-__version__ = "0.9.0"
+__version__ = "1.0.0"

{uedition-0.9.0 → uedition-1.0.0}/uedition/cli/build.py

@@ -15,11 +15,11 @@ from uedition.settings import reload_settings, settings
 
 def landing_build() -> None:
     """Build the landing page."""
-    if not path.exists(settings["output"]):
-        makedirs(settings["output"], exist_ok=True)
-    with open(path.join(settings["output"], "config.json"), "w") as out_f:
+    if not path.exists(settings["output"]["path"]):
+        makedirs(settings["output"]["path"], exist_ok=True)
+    with open(path.join(settings["output"]["path"], "config.json"), "w") as out_f:
         json.dump(settings, out_f)
-    with open(path.join(settings["output"], "index.html"), "w") as out_f:
+    with open(path.join(settings["output"]["path"], "index.html"), "w") as out_f:
         out_f.write(
             """\
 <!DOCTYPE html>
@@ -151,37 +151,39 @@ def full_build(lang: dict) -> None:
             "build",
             "--all",
             "--path-output",
-            path.join("_build", lang["code"]),
+            path.join("_build", lang["path"]),
             lang["path"],
         ],
         check=False,
     )
-    subprocess.run(
-        [  # noqa: S603, S607
-            "jupyter-book",
-            "build",
-            "--all",
-            "--path-output",
-            path.join("_build", lang["code"]),
-            "--builder",
-            "custom",
-            "--custom-builder",
-            "tei",
-            lang["path"],
-        ],
-        check=False,
-    )
-    copytree(
-        path.join("_build", lang["code"], "_build", "html"),
-        path.join(settings["output"], lang["code"]),
-        dirs_exist_ok=True,
-    )
+    if settings["output"]["tei"]:
+        subprocess.run(
+            [  # noqa: S603, S607
+                "jupyter-book",
+                "build",
+                "--all",
+                "--path-output",
+                path.join("_build", lang["path"]),
+                "--builder",
+                "custom",
+                "--custom-builder",
+                "tei",
+                lang["path"],
+            ],
+            check=False,
+        )
     copytree(
-        path.join("_build", lang["code"], "_build", "tei"),
-        path.join(settings["output"], lang["code"]),
-        ignore=ignore_patterns("_sphinx_design_static"),
+        path.join("_build", lang["path"], "_build", "html"),
+        path.join(settings["output"]["path"], lang["path"]),
         dirs_exist_ok=True,
     )
+    if settings["output"]["tei"]:
+        copytree(
+            path.join("_build", lang["path"], "_build", "tei"),
+            path.join(settings["output"]["path"], lang["path"]),
+            ignore=ignore_patterns("_sphinx_design_static"),
+            dirs_exist_ok=True,
+        )
 
 
 def partial_build(lang: dict) -> None:
@@ -192,41 +194,43 @@ def partial_build(lang: dict) -> None:
             "jupyter-book",
             "build",
             "--path-output",
-            path.join("_build", lang["code"]),
+            path.join("_build", lang["path"]),
             lang["path"],
         ],
         check=False,
     )
-    subprocess.run(
-        [  # noqa: S603, S607
-            "jupyter-book",
-            "build",
-            "--path-output",
-            path.join("_build", lang["code"]),
-            "--builder",
-            "custom",
-            "--custom-builder",
-            "tei",
-            lang["path"],
-        ],
-        check=False,
-    )
-    copytree(
-        path.join("_build", lang["code"], "_build", "html"),
-        path.join(settings["output"], lang["code"]),
-        dirs_exist_ok=True,
-    )
+    if settings["output"]["tei"]:
+        subprocess.run(
+            [  # noqa: S603, S607
+                "jupyter-book",
+                "build",
+                "--path-output",
+                path.join("_build", lang["path"]),
+                "--builder",
+                "custom",
+                "--custom-builder",
+                "tei",
+                lang["path"],
+            ],
+            check=False,
+        )
     copytree(
-        path.join("_build", lang["code"], "_build", "tei"),
-        path.join(settings["output"], lang["code"]),
-        ignore=ignore_patterns("_sphinx_design_static"),
+        path.join("_build", lang["path"], "_build", "html"),
+        path.join(settings["output"]["path"], lang["path"]),
         dirs_exist_ok=True,
     )
+    if settings["output"]["tei"]:
+        copytree(
+            path.join("_build", lang["path"], "_build", "tei"),
+            path.join(settings["output"]["path"], lang["path"]),
+            ignore=ignore_patterns("_sphinx_design_static"),
+            dirs_exist_ok=True,
+        )
 
 
 def run() -> None:
     """Build the full uEdition."""
-    if path.exists(settings["output"]):
-        rmtree(settings["output"])
+    if path.exists(settings["output"]["path"]):
+        rmtree(settings["output"]["path"])
     for lang in settings["languages"]:
         full_build(lang)

{uedition-0.9.0 → uedition-1.0.0}/uedition/cli/serve.py

@@ -39,4 +39,4 @@ def run() -> None:
         server.watch(path.join("static", "**", "*.*"), full_cmd)
         server.watch(path.join(lang["path"], "**", "*.*"), partial_cmd)
     server.watch("uEdition.*", lambda: [cmd() for cmd in full_rebuilds])
-    server.serve(root="site", port=8000)
+    server.serve(root=settings["output"]["path"], port=8000)

{uedition-0.9.0 → uedition-1.0.0}/uedition/ext/language_switcher.js

@@ -1,4 +1,4 @@
-(function() {
+(function () {
     async function setup() {
         try {
             let buttonContainer = document.querySelector('.article-header-buttons');
@@ -39,7 +39,7 @@
                     link.classList.add('fw-bold');
                 }
                 link.innerHTML = langConfig.label;
-                link.setAttribute('href', DOCUMENTATION_OPTIONS.URL_ROOT + '../' + langConfig.path + '/' + DOCUMENTATION_OPTIONS.pagename + DOCUMENTATION_OPTIONS.LINK_SUFFIX);
+                link.setAttribute('href', document.querySelector("html").getAttribute("data-content_root") + '../' + langConfig.path + '/' + DOCUMENTATION_OPTIONS.pagename + DOCUMENTATION_OPTIONS.LINK_SUFFIX);
 
                 item.append(link);
                 menu.append(item);
@@ -50,7 +50,7 @@
             container.append(button);
             container.append(menu);
             buttonContainer.prepend(container);
-        } catch(e) {
+        } catch (e) {
             console.error(e);
         }
     }

{uedition-0.9.0 → uedition-1.0.0}/uedition/ext/language_switcher.py

@@ -32,5 +32,6 @@ def copy_custom_files(app: Sphinx, exc: bool) -> None:  # noqa: FBT001
 
 def setup(app: Sphinx) -> None:
     """Set up the Language switcher extension."""
-    app.connect("builder-inited", add_language_switcher)
-    app.connect("build-finished", copy_custom_files)
+    if len(settings["languages"]) > 1:
+        app.connect("builder-inited", add_language_switcher)
+        app.connect("build-finished", copy_custom_files)

{uedition-0.9.0 → uedition-1.0.0}/uedition/ext/tei/__init__.py

@@ -7,6 +7,7 @@ from sphinx.application import Sphinx
 from sphinx.util.fileutil import copy_asset_file
 
 from uedition.ext.tei import parser
+from uedition.settings import settings
 
 
 def add_language_switcher(app: Sphinx) -> None:
@@ -26,5 +27,6 @@ def copy_custom_files(app: Sphinx, exc: bool) -> None:  # noqa: FBT001
 def setup(app: Sphinx) -> None:
     """Set up the TEI Sphinx extension."""
     parser.setup(app)
-    app.connect("builder-inited", add_language_switcher)
-    app.connect("build-finished", copy_custom_files)
+    if settings["output"]["tei"]:
+        app.connect("builder-inited", add_language_switcher)
+        app.connect("build-finished", copy_custom_files)

{uedition-0.9.0 → uedition-1.0.0}/uedition/ext/tei/builder.py

@@ -56,6 +56,8 @@ MAPPINGS = [
     },
     {"cls": nodes.inline, "tagname": "hi", "type": "inline"},
     {"cls": nodes.literal, "tagname": "hi", "type": "inline"},
+    {"cls": nodes.strong, "tagname": "hi", "type": "inline", "attrs": [{"target": "rend", "value": "bold"}]},
+    {"cls": nodes.emphasis, "tagname": "hi", "type": "inline", "attrs": [{"target": "rend", "value": "italic"}]},
     {"cls": nodes.label, "tagname": "label", "type": "inline"},
     {
         "cls": nodes.reference,
@@ -139,7 +141,7 @@ class TEITranslator(nodes.GenericNodeVisitor):
                 for attr in node.attlist():
                     if "source" in attr_rule and attr[0] == attr_rule["source"]:
                         output_attrs[attr_rule["target"]] = attr[1]
-                if isinstance(output_attrs[attr_rule["target"]], list):
+                if attr_rule["target"] in output_attrs and isinstance(output_attrs[attr_rule["target"]], list):
                     joiner = attr_rule["join"] if "join" in attr_rule else " "
                     if "format" in attr_rule:
                         output_attrs[attr_rule["target"]] = joiner.join(

{uedition-0.9.0 → uedition-1.0.0}/uedition/settings.py

@@ -6,10 +6,11 @@
 All application settings are accessed via the `settings` dictionary.
 """
 import os
-from typing import Any, Dict, Tuple, Type
+from typing import Annotated, Any, Dict, Tuple, Type
 
 from pydantic import BaseModel
 from pydantic.fields import FieldInfo
+from pydantic.functional_validators import BeforeValidator
 from pydantic_settings import BaseSettings, PydanticBaseSettingsSource
 from yaml import safe_load
 
@@ -87,6 +88,22 @@ class AuthorSettings(BaseModel):
     """The author's contact e-mail."""
 
 
+class OuputSettings(BaseModel):
+    """Settings for the output configuration."""
+
+    path: str = "docs"
+    """The output path."""
+    tei: bool = True
+    """Whether to generate TEI output."""
+
+
+def convert_output_str_to_dict(value: str | dict) -> dict:
+    """Convert the simple output directory string to a dictionary."""
+    if isinstance(value, str):
+        return {"path": value}
+    return value
+
+
 class Settings(BaseSettings):
     """Application settings."""
 
@@ -96,7 +113,7 @@ class Settings(BaseSettings):
     """The author settings."""
     languages: list[LanguageSetting] = []
     """The configured languages."""
-    output: str = "docs"
+    output: Annotated[OuputSettings, BeforeValidator(convert_output_str_to_dict)] = OuputSettings()
     """The output directory."""
     repository: RepositorySettings = RepositorySettings()
     """The repository settings."""

uedition-0.9.0/docs/de/user/create.md

@@ -1,13 +0,0 @@
-# Creating a μEdition
-
-With all the pre-requisites installed correctly, you are now ready to create your first μEdition. On the commandline
-navigate to the folder where you want to create your μEdition and run:
-
-:::{code-block} console
-$ copier copy https://github.com/uEdition/uEdition-project-template my-edition
-:::
-
-Replace `my-edition` with the name of the folder you want your edition to be created in. The setup process will ask
-you a few questions about your new μEdition and create a skeleton μEdition in the folder you specified.
-
-On the commandline, navigate into that new folder and all further commands are to be run inside that folder.

uedition-0.9.0/docs/en/user/index.md

@@ -1,7 +0,0 @@
-# User Guide
-
-Welcome to the μEdition User Guide, which guides you, the editor, through the process of {doc}`creating a new μEdition <create>`,
-{doc}`adding languages <language-add>` and {doc}`content <content>` to it, and {doc}`publishing it to GitHub Pages <publish>`.
-
-The user guide tries to assume as little prior knowledge as possible, but you are expected to be able to navigate the
-command-line. Additionally, for publishing via GitHub Pages, basic Git knowledge is also required.

uedition-0.9.0/docs/en/user/installation.md

@@ -1,37 +0,0 @@
-# Installation
-
-The μEdition is built on top of a set of other tools and in order to create our first μEdition, it is necessary to first
-install these dependencies.
-
-The μEdition is built in Python and supports version 3.10 and 3.11 [^python-version]. In order to use it, please
-[install an appropriate version of Python for your operating system](https://python.org/downloads).
-
-For the initial creation of a new μEdition, the μEdition uses a tool called [Copier](https://copier.readthedocs.io/en/stable/).
-To install all required μEdition dependencies and to run the various μEdition tools, [Hatch](https://hatch.pypa.io)
-is used.
-
-The easiest way to install both Copier and Hatch is via [pipx](https://pypa.github.io/pipx/), which you can
-[install from here](https://pypa.github.io/pipx/installation/). When you have pipx installed, then on the commandline
-run the following command to install Copier:
-
-:::{code} console
-$ pipx install copier
-$ pipx install hatch
-:::
-
-You can test that your installation has been successful by running
-
-:::{code} console
-$ copier
-$ hatch
-:::
-
-If the two commands show you a summary of the available options and commands, then the core tools are installed correctly.
-
-In order to work collaboratively and for the GitHub Pages publishing functionality to work, you also need to install the
-version control system [Git](https://git-scm.com/downloads). Providing you with a full intro to using git exceeds the
-space we have here, but there are many good git tutorials out there and there is also the
-[official documentation](https://git-scm.com/doc).
-
-[^python-version]: The μEdition is tested using Python 3.10 and 3.11. It may also work on newer Python version,
-  it just hasn't been tested on those.

uedition-0.9.0/docs/en/user/language-add.md

@@ -1,14 +0,0 @@
-# Adding a Language
-
-The μEdition has multi-language support as a core principle. Thus, even if you are planning to release your edition in
-a single language only, you need to explicitly configure this one language.
-
-To add a language to your μEdition, run the following command:
-
-:::{code-block} console
-$ hatch run uEdition language add FOLDER_NAME
-:::
-
-Replace `FOLDER_NAME` with the name of the folder that the μEdition content for that language is to be placed in. The
-process will ask you for some detail about the language you are adding and will then create skeleton in the folder,
-which is then ready for editing.

uedition-0.9.0/docs/pyproject.toml

@@ -1,34 +0,0 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[project]
-name = "uedition_docs"
-description = 'The μEdition Documentation'
-requires-python = ">=3.10"
-keywords = []
-authors = [
-  { name = "Mark Hall", email = "mark.hall@work.room3b.eu" },
-]
-classifiers = [
-  "Development Status :: 4 - Beta",
-  "Programming Language :: Python",
-  "Programming Language :: Python :: 3.10",
-  "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: Implementation :: CPython",
-  "Programming Language :: Python :: Implementation :: PyPy",
-]
-dependencies = [
-  "uedition>=0.7.0",
-]
-version = "1.0.0"
-
-[project.urls]
-Documentation = "https://github.com/scmmmh/under-the-surface/-#readme"
-Issues = "https://github.com/scmmmh/under-the-surface/-/issues"
-Source = "https://github.com/scmmmh/under-the-surface/-"
-
-[tool.hatch.envs.default.scripts]
-build = "uEdition build"
-serve = "uEdition serve"
-update = "uEdition update"