Sphinx quick start

Aceste tutoriale sunt scrise in ReStructured, si compilate in html cu Sphinx.

Mai jos sunt instructiuni pentru a “instala” sphinx pe masina locala. Instructiuni de folosire si tutoriale se gasesc pe internet.

Sphinx e scris in python asa ca trebuie instalat si Python-ul.

Instructiunile sunt testate pe Ubuntu 16.04, 18.04 si Windows 10.

Instalare sphinx

Se descarca ultima versiune de miniconda: https://docs.conda.io/en/latest/miniconda.html pentru OS-ul potrivit.

Se instaleaza.

Pentru Windows, deschideti Anaconda CMD (de la meniul de Start). Ar trebui sa deschida o fereastra CMD normala dar cu (base) in fata.

Rulati:

conda init powershell

Ar trebui sa mearga. Daca se plange ca nu poate accesa fisierul x sau y, poate fi de la antivirus. Daca acest pas nu poate fi facut, s-ar putea ca integrarea Python cu anumite IDE-uri (ex Visual Studio Code) sa nu fie buna.

Tot din Anaconda CMD se creaza un virtual environment in care se va integra si sphinx-ul:

conda create -y --copy -c anaconda --name sph python=3.8
conda activate sph
pip install sphinx

Daca aveti deja un proiect Sphinx, puteti sa il compilati. Daca nu, treceti la sectiunea urmatoare (crearea unu proiect).

Daca vreti sa compilati, trebuie sa va asigurati ca mediul sph este activ. Deschideti o consola Anaconda si rulati

conda activate sph

Acum intrati in directorul proiectului (ex: tutoriale/) si rulati:

make html

Rezultatul se va salva in directorul tutoriale/build/html/.

Nota: In Linux, de obicei git si anaconda isi configureaza corect caile si nu exista consola git sau consola conda. Deeschideti un terminal bash normal. Conceptul de virtual environment se pastreaza, asa ca, si in Linux aveti (base) sau (sph) in fata prompt-ului

Crearea unui proiect de la zero.

Faceti-va un folder de lucru. Eventual un repository. In radacina directorului de lucru, avand activ mediul sph:

sphinx-quickstart

Recomandarea mea este sa aveti un folder cu surse si unul de build. Folderul de build trebuie trecut in .gitignore (daca folositi versionarea)