Comment créer un projet de documentations placé en dehors du répertoire docs en utilisant ReadTheDocs?

Question

Je génère un projet de documentation en utilisant ReadThedocs(mkdocs). Mais Il génère un projet de documentation pour les fichiers .md qui sont placés dans le répertoire docs. Mon exigence est, je veux construire un projet de documentation pour chaque fichier .md placé n'importe où dans le référentiel github.

Comment y parvenir?

Answer 1

Vous devez spécifier dans la configuration Mkdocs (mkdocs.yml) l'emplacement de votre documentation directory être le répertoire courant '.'.

Exemple:

site_name: My Documentation Project 
docs_dir: '.' 

Par défaut, le Mkdocs regarde dans un sous-répertoire de votre projet labled docs:

docs_dir

vous permet de définir le répertoire contenant les sources de documentation fichiers Markdown . Cela peut être soit un répertoire relatif, auquel cas il est résolu par rapport au répertoire contenant votre fichier de configuration, soit un chemin de répertoire absolu.

par défaut: 'docs'