#python-sphinx
Вопрос:
В проекте, над которым я работаю, документация выполняется с помощью Sphinx. В README.md упоминает ли CONTRIBUTING.md который находится в папке с именем .github.
Когда документ создается, ссылка на файл вклада превращается в https://myproject.github.io/.github/CONTRIBUTING.md но на самом деле этого не существует.
Я ищу способ сказать сфинксу, чтобы он просматривал .github/*.md. Многие решения, которые я нашел в Интернете, не работали (в основном с использованием .. include::). Лучшее, что я мог бы сделать, это скопировать папку .github в папку docs, а затем использовать .. include:: но это не очень удовлетворительно.
У кого-нибудь есть идея, как я мог бы это сделать, не повредив большую часть дерева папок? (Я не являюсь руководителем проекта, поэтому большие изменения могут быть не приняты)
Комментарии:
1. Пожалуйста, включите в свой текст разметку
README.md
, которая создает ссылкуhttps://myproject.github.io/.github/CONTRIBUTING.md
, отредактировав свой вопрос. Моим первым предложением было бы сослаться на внешнюю ссылку .