RTD compile tous mes documents, y compris les documents étrangers des sous-modules git

Question

J'expérimente avec Sphinx et ReadTheDocs (RTD) pour compiler ma documentation sur chaque poussée GitHub. Malheureusement, RTD a trouvé plusieurs dossiers doc/docs contenant un fichier conf.py. Mon repository utilise des sous-modules git pour intégrer des bibliothèques tierces. Certains d'entre eux sont également documentés en utilisant Sphinx. Je suppose que la plus grande (documentation de longue durée) gagne et écrase toutes les pages HTML statiques dans la vue RTD finale.

Comment puis-je exclure ou dire RTD d'ignorer les dossiers de ces sous-modules:

lib/cocotb 
lib/osvvm 
lib/vunit 
docs/source/_themes/sphinx_rtd_theme 

Ma documentation se trouve ici:

docs/source/conf.py 
docs/source/index.rst 

Pour autant que je l'ai trouvé, RTD ne support *.yml fichiers, mais il n'y a pas d'entrée pour définir le dossier racine de la documentation.

Des idées pour résoudre mon problème?

Answer 1

Le dossier de documentation principal et son conf.py peuvent être configurés dans l'onglet Paramètres avancés dans les paramètres par projet.

valeur Exemple: documentation/conf.py

Answer 2

intérieur conf.py, il y a une liste qui ressemble à ceci

# List of patterns, relative to source directory, that match files and 
# directories to ignore when looking for source files. 
exclude_patterns = [] 

Vous pouvez mettre les fichiers à ignorer l'intérieur comme

exclude_patterns = ["lib/cocotb", "lib/osvvm", "lib/vunit", "docs/_themes/sphinx_rtd_theme"] 

S'il vous plaît noter que ici le modèle est par rapport à le répertoire source, vous pouvez mettre / au début de chaque modèle de fichier ci-dessus pour le rendre plus clair.