Почему Github Pages не обслуживает мою документацию? - PullRequest
Новая
       3

Почему Github Pages не обслуживает мою документацию?

2 голосов
/ 25 февраля 2020

Я использую sphinx для создания html документации, и я нахожусь в процессе открытия некоторых частных репозиториев моей компании.

Внутренне мы предоставляем документацию из корзины S3 через Cloudfront, чтобы мы могли поместить контроль доступа перед ним. Но для открытого исходного кода я полагал, что публикация через Github Pages будет способом наименьшего сопротивления.

Однако я не могу заставить сервис работать правильно.

Вот мой репозиторий , с моим индексом. html в папке / docs.

Вот сайт , к которому не применяется ни один из связанных css, и со всеми ссылками на страницы не работает.

Я попытался изолировать проблему, сделав тестовое репо с помощью только встроенной документации и опубликовав его с мастера.

Как вы можете видеть , этот даже не пытается обслуживать индекс. html, я просто получаю страницу 404.

Эти файлы работают как локально, так и при обслуживании с AWS, поэтому я немного в недоумении, почему Github Pages не обслуживает его правильно. Я чувствую, что должен делать какой-то тупой недосмотр. Если бы кто-то с большим опытом мог взглянуть и указать мне на ошибку моих путей, я был бы очень признателен. Я бэкэнд-инженер по большей части, так что логи сайта c немного за пределами моей обычной рубки. Заранее спасибо!

Ответы [ 2 ]

1 голос
/ 25 февраля 2020

Для всех, кто сталкивался с тем же, я понял это. Поскольку я предварительно строю сайт в своем конвейере CI / CD, мне не нужен jekyll, чтобы создать сайт для меня, и мне нужно добавить пустой файл конфигурации для него.

С [здесь] [ https://www.docslikecode.com/articles/github-pages-python-sphinx/] :

Затем вы настраиваете файл .nojekyll, чтобы указать, что вы не используете Jekyll в качестве генератора сайта stati c в этом хранилище.

Спасибо за помощь!

0 голосов
/ 25 февраля 2020

Вам нужно _config.yml, и вам нужно включить github-страницы на Master для репо (go в настройках). После этого вам также понадобится Gemfile: 

source 'https://rubygems.org'

gem 'github-pages'

Обычно сайт страниц GitHub должен быть в root, а ваш выглядит так, как будто он находится в папке / docs, поэтому я Я уверен, что вы можете Google, как это сделать. Это может быть невозможно, хотя со страницами GH я не уверен.

Если это , должно быть подпапкой, а не root проекта, возможно, что-то подобное будет работать: https://gist.github.com/cobyism/4730490

Вот что в моем _config: для скелетов: 

permalink: pretty
sass:
  sass_dir: _scss
  style: compressed

Я уверен, что вы можете оставить sass вне

...