Skip to content

Commit 008017f

Browse files
committed
Updating the documentation adding the `easy-versioning-setup command.
1 parent b81f536 commit 008017f

File tree

3 files changed

+30
-11
lines changed

3 files changed

+30
-11
lines changed

Example/src/V. 2.0/Deutsch/install_and_use.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Zuerst sollte die Projektstruktur für die Dokumentation wie folgt aufgebaut sei
1414

1515
📦 Easy_versioning_Sphinx/
1616
├── 📂 data/
17-
│ └── 📄 Footer.md
17+
│ └── 📄 Footer.html
1818
├── 📂 src/
1919
│ ├── 📁 V. X.XX/
2020
│ │ ├── 🌐 Sprache 1/
@@ -24,6 +24,12 @@ Zuerst sollte die Projektstruktur für die Dokumentation wie folgt aufgebaut sei
2424
│ ├── 📁 V. Y.YY/
2525
│ ├── 📁 V. Z.ZZ/
2626

27+
Falls ein Projekt noch nicht gestartet wurde, kann der Befehl `easy-versioning-setup` verwendet werden, um die oben dargestellte Struktur automatisch zu erzeugen und so die ersten Entwicklungsphasen zu vereinfachen.
28+
Der Befehl `easy-versioning-setup` akzeptiert bis zu zwei optionale Parameter: den **Projektnamen** und den **Autornamen**. Wenn diese nicht angegeben werden, werden die Standardwerte "Documentation" und "Author" verwendet.
29+
Die eingegebenen Parameter werden ausschließlich für die Erstellung des Sphinx-Projekts innerhalb der konfigurierten Ordner genutzt und dürfen keine Leerzeichen enthalten.
30+
Beispiel:
31+
`easy-versioning-setup Test_Easy_Versioning Niccolò_Quadrani`
32+
2733
Anschließend eine Konsole öffnen, in das Hauptverzeichnis des Projekts wechseln (in unserem Beispiel `Easy_versioning_Sphinx/`) und folgenden Befehl ausführen: `Easy_versioning_build`
2834

2935
Der Befehl `Easy_versioning_build` akzeptiert bis zu zwei optionale Parameter:

Example/src/V. 2.0/English/install_and_use.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ First, structure your documentation project folders as follows:
1414

1515
📦 Easy_versioning_Sphinx/
1616
├── 📂 data/
17-
│ └── 📄 Footer.md
17+
│ └── 📄 Footer.hmtl
1818
├── 📂 src/
1919
│ ├── 📁 V. X.XX/
2020
│ │ ├── 🌐 Language 1/
@@ -24,6 +24,13 @@ First, structure your documentation project folders as follows:
2424
│ ├── 📁 V. Y.YY/
2525
│ ├── 📁 V. Z.ZZ/
2626

27+
28+
If a project has not yet been started, the `easy-versioning-setup` command can be used to automatically generate the structure shown above, thus simplifying the initial development phases.
29+
The `easy-versioning-setup` command accepts up to two optional parameters: the **project name** and the **author name**. If not specified, the default values "Documentation" and "Author" will be assigned.
30+
The input parameters will be used exclusively for creating the Sphinx project within the configured folders and must not contain spaces.
31+
Example:
32+
`easy-versioning-setup Test_Easy_Versioning Niccolò_Quadrani`
33+
2734
Then open a terminal, navigate to the project’s root folder (in this example, `Easy_versioning_Sphinx/`), and run the command:
2835
`Easy_versioning_build`
2936

Example/src/V. 2.0/Italiano/install_and_use.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Per iniziare, è necessario organizzare le cartelle del progetto di documentazio
1111

1212
📦 Easy_versioning_Sphinx/
1313
├── 📂 data/
14-
│ └── 📄 Footer.md
14+
│ └── 📄 Footer.html
1515
├── 📂 src/
1616
│ ├── 📁 V. X.XX/
1717
│ │ ├── 🌐 Language 1/
@@ -21,9 +21,15 @@ Per iniziare, è necessario organizzare le cartelle del progetto di documentazio
2121
│ ├── 📁 V. Y.YY/
2222
│ ├── 📁 V. Z.ZZ/
2323

24-
Dopodiché, aprire una console e posizionarsi nella directory principale del progetto (`Easy_versioning_Sphinx/` nel nostro esempio), quindi eseguire il comando: `Easy_versioning_build`
24+
Nel caso in cui non sia ancora stato avviato un progetto, è possibile utilizzare il comando `easy-versioning-setup` per generare automaticamente la struttura illustrata in precedenza, semplificando così le fasi iniziali dello sviluppo.
25+
Il comando `easy-versioning-setup` accetta fino a due parametri opzionali: il **nome del progetto** e il **nome dell’autore**, se non specificati, verranno assegnati i valori predefiniti "Documentation" e "Author".
26+
I parametri forniti in input saranno utilizzati esclusivamente per la creazione del progetto Sphinx all’interno delle cartelle configurate e non devono contenere spazi.
27+
Esempio:
28+
`easy-versioning-setup Test_Easy_Versioning Niccolò_Quadrani`
2529

26-
Il comando `Easy_versioning_build` accetta fino a due parametri opzionali:
30+
Dopodiché, aprire una console e posizionarsi nella directory principale del progetto (`Easy_versioning_Sphinx/` nel nostro esempio), quindi eseguire il comando: `Easy-versioning-build`
31+
32+
Il comando `Easy-versioning-build` accetta fino a due parametri opzionali:
2733

2834
1. **Lingua principale del progetto** (stringa): necessaria per garantire un corretto reindirizzamento nel caso in cui una versione della documentazione non sia disponibile in tutte le lingue. La lingua specificata deve essere presente in ogni versione del progetto.
2935

@@ -35,12 +41,12 @@ I file all’interno della cartella `src/` **non verranno mai modificati o sovra
3541

3642
## Form di cambio lingua
3743

38-
Se, oltre alla cartella `src/`, viene aggiunta anche una directory `data/` contenente un file `footer.md`, sarà possibile personalizzare il footer della documentazione includendo un modulo per il cambio di versione e lingua.
44+
Se, oltre alla cartella `src/`, viene aggiunta anche una directory `data/` contenente un file `footer.html`, sarà possibile personalizzare il footer della documentazione includendo un modulo per il cambio di versione e lingua.
3945

40-
Un esempio funzionante di `footer.md` è disponibile qui: [GitHub](https://github.com/Quadra-Ryo/Easy-versioning-sphinx/blob/main/Easy_versioning/footer.md).
41-
In assenza del file `data/footer.md`, verrà utilizzato il template predefinito reperibile al link indicato sopra.
46+
Un esempio funzionante di `footer.html` è disponibile qui: [GitHub](https://github.com/Quadra-Ryo/Easy-versioning-sphinx/blob/main/Easy_versioning/footer.md).
47+
In assenza del file `data/footer.html`, verrà utilizzato il template predefinito reperibile al link indicato sopra.
4248

4349
Esempi:
44-
- `easy_versioning_build` — Utilizza l'inglese come lingua predefinita ed elimina la cartella `_source`.
45-
- `easy_versioning_build Italiano 0` — Imposta "Italiano" come lingua predefinita (quindi lo strumento cercherà la cartella "Italiano" all'interno della cartella delle versioni) e mantiene intatta la cartella `_source`.
46-
- `easy_versioning_build Deutsch` — Imposta "Deutsch" come lingua predefinita ed elimina la cartella `_source`.
50+
- `easy-versioning-build` — Utilizza l'inglese come lingua predefinita ed elimina la cartella `_source`.
51+
- `easy-versioning-build Italiano 0` — Imposta "Italiano" come lingua predefinita (quindi lo strumento cercherà la cartella "Italiano" all'interno della cartella delle versioni) e mantiene intatta la cartella `_source`.
52+
- `easy-versioning-build Deutsch` — Imposta "Deutsch" come lingua predefinita ed elimina la cartella `_source`.

0 commit comments

Comments
 (0)