Comment charger de la documentation avec Sphinx sur un sous-dossier du serveur debian

Je suis assez nouveau du côté du sphinx. J’ai lu des informations à ce sujet sur le site de documentation officiel de Sphinx et j’ai suivi ces étapes pour l’installer et le configurer sur mon serveur Debian Wheezy:

  1. Tout d’abord, j’ai installé la source Sphinx sur http://example.com/documentation-path/ .

    pince installer sphinx

  2. J’ai exécuté le script sphinx-quickstart pour configurer le répertoire racine et le fichier conf.py.

    sphinx-quickstart

  3. J’ai exécuté la commande make html pour créer des fichiers HTML dans mon chemin de répertoire.

    faire html

  4. J’ai installé le sphinx autobuild pour gérer toutes les modifications / mises à jour de ma documentation, comme écrit dans un article de @ toast38coza .

    pip installer sphinx-autobuild

    sphinx-autobuild source build / html

[ Ce que j’ai déjà corrigé ]

Mon premier problème était que je ne pouvais pas obtenir une vue correcte du modèle d’index de documentation puisque le serveur commençait à regarder les modifications sur les fichiers de documentation à l’ adresse http://127.0.0.1:8000 (localhost sur le port 8000). Donc, j’obtiens le même chemin d’URL que je m’attendais quand je l’ai installé localement sur mon PC actuel. Et comme je l’ai dit dans le test de la version locale, cela a bien fonctionné.

Comme je cherchais quelque chose comme ça en tant que configuration de chemin d’URL ( http://example.com ), j’ai décidé d’append des arguments comme -host et -port pour que cela fonctionne bien sur debian:

Option -p / -port pour spécifier le port sur lequel la documentation doit être servie (8000 par défaut) -H / – option hôte pour spécifier l’hôte sur lequel la documentation doit être servie (par défaut 127.0.0.1)

Ensuite, je l’ai configuré, lancé et cela a bien fonctionné:

>> sphinx-autobuild source build/html --host http://example.com --port8000 

Alors maintenant, si je surfe sur http://example.com:8000, j’obtiens la vue correcte du modèle d’index de la documentation.

[Ma question principale]

Comment puis-je lancer cette vue sur un chemin d’URL différent, par exemple un sous-dossier tel que http://example.com/documentation-path/ , même si le chemin racine de l’installation de Sphinx était / documentation-path /?

[Ma deuxième question]

Comment puis-je automatiser le processus de visualisation de la vue modèle sans écrire à chaque fois l’instruction sphinx-autobuild avec –port et –host sur la console Debian?

[Avis important]

Le serveur Debian est actuellement configuré avec NGINX, ce qui est complètement nouveau pour moi.

Enfin, j’ai résolu le problème de chemin de sous-dossier par moi-même à l’aide de la documentation NGINX .

 location /documentation { proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_pass http://localhost:8000; index index.php index.html index.htm; } 

En ce qui concerne le problème de chargement automatique, je viens de passer de Sphinx à Markdown et ensuite, j’ai utilisé couscousPHP pour générer un site Web de pages GitHub à partir de la documentation de Markdown .

C’était pour moi le moyen le plus intelligent de fournir des fichiers html statiques sans chargement automatique à chaque fois qu’une source de la console ssh. En fait, je peux facilement générer mon fichier HTML de conversion à partir du fichier .md en tapant la commande couscous generate .