Создание отдельной темы для отдельных URL для Readthedocs - PullRequest
0 голосов
/ 08 июня 2019

Я ищу решение, которое позволило бы нам иметь отдельные темы во встроенных документах через rtd, основанные на URL. Проект размещен на github, поэтому мы используем интеграцию Webhook для rtd.

По сути, нам бы хотелось, чтобы slug .readthedocs.io использовал значение по умолчанию и имел собственный домен через rtd, т.е. docs.ourdomain.org, использовал тему, стилизованную под наш сайт.

on_rtd, похоже, равно True всякий раз, когда rtd создает документы, так что это, вероятно, бесполезно, но, пожалуйста, исправьте меня, если я ошибаюсь.

Возможно, несколько Webhooks? Некоторая магия sphinx, которую я еще не обнаружил?

Рассматривая использование веток или тегов, но это кажется немного сложным, и, я полагаю, потребовало бы нескольких имен проектов в rtd. Хотя, пожалуйста, поправьте меня, если я ошибаюсь.

На данный момент мы реализовали тему нашего сайта и просто позволили это сделать обоим, но в идеале мы надеемся, что сайт slug .readthedocs.io будет более общим и -линии с чувством readthedocs.io.

1 Ответ

0 голосов
/ 08 июня 2019

На данный момент Read the Docs не поддерживает несколько тем для данного репо / филиала.

Здесь есть по крайней мере несколько подходов.

1) Используйте ветки для размещения альтернативных документов.Прочитайте Документы имеет пример проекта, иллюстрирующий этот подход здесь:

2) Использовать подпроекты .

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

...