Как публиковать одновременно сгенерированные Sphinx документы и Markdown на страницах GitHub? - PullRequest
0 голосов
/ 13 октября 2019

Я хотел бы опубликовать оба сгенерированных Sphinx документа для проекта Python и Содержимое уценки в том же проекте GitHub Pages.

Поскольку документы Sphinx содержат папки, начинающиеся с подчеркивания, например, _static, а Jekyll рассматривает их как особые, общая рекомендация выглядит так: просто поместите файл .nojekyll в корневой каталог GitHub Pages.

К сожалению, я также хочу опубликовать некоторый контент, которыйнаписано в Markdown и для этого нужно правильно отобразить Jekyll.

Идея состоит в том, чтобы иметь документы Sphinx во вложенной папке с именем docs и содержимое Markdown в корневой папке. Примерно так:

root-+-docs-+-_static--+--...
     |      +-_sources-+--...
     +-somefile.md

Использование .nojekyll не вариант, потому что тогда somefile.md не будет обработан.

Мне кажется, что я смогу решить эту проблемус директивой include .

Принудительное включение каталогов и / или файлов в преобразование. .htaccess является хорошим примером, так как точечные файлы по умолчанию исключены.

Поэтому я попробовал следующее _config.yml (помещено в корневую папку):

github: [metadata]
encoding: UTF-8
kramdown:
    input: GFM
    hard_wrap: false
    toc_levels: 1..3
future: true
jailed: false
theme: jekyll-theme-cayman
gfm_quirks: paragraph_end
include: ['docs/_static/','docs/_sources/','docs/_modules/']

К сожалению,этот конфиг все равно приводит к 404 с при попытке загрузить что-либо из docs/_static/.

Как я могу заставить это работать?

1 Ответ

0 голосов
/ 13 октября 2019

Кажется, что самое простое решение - просто использовать два репозитория GitHub:

  • Один для Sphinx (с .nojekyll)
  • Один для содержимого Markdown
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...