Подтвердить что ты не робот

Хостинг частной документации по сфинксу

В настоящее время я пишу некоторую обширную документацию, используя Sphinx для довольно сложного веб-сайта Django. Я работаю над этим в доме, и, прежде чем скоро уйду, я хочу оставить подробную документацию, доступную для новых разработчиков/админов для сайта.

Мой вопрос в том, какие у меня варианты для размещения этой документации? Я бы предпочел, чтобы он был приватным. Кроме того, документы касаются веб-сайта, а не пакета python. По этим двум причинам я думаю, что чтение документов может быть не самым подходящим вариантом.

Я столкнулся с django-sphinxdoc, хотя для этого требуется установка Haystack в качестве бэкэнд. Не существует способа просто обработать документы с помощью встроенного js-поиска? Или услуга, которая позволяет приватный хостинг документов?

Любые варианты были бы оценены.

4b9b3361

Ответ 1

Sphinx может генерировать статические файлы .html (make html). Поместите эти HTML файлы на внутренний веб-сервер, и вам должно быть хорошо идти.

Ответ 2

Я чувствовал такую ​​же потребность в размещении документации в частном порядке. Поэтому я создал веб-службу, которая поддерживает частный хостинг документации Sphinx: HasDocs.

http://www.hasdocs.com/

Это должно устранить необходимость в настройке собственного веб-сервера и т.д. Вы можете синхронизировать свои репозитории и разрешения GitHub. Частные проекты имеют частные документы, доступные только тем, у кого есть права. Документация восстанавливается всякий раз, когда вы вводите новый код в репозиторий GitHub.

В настоящее время он находится в бета-версии и поддерживает Sphinx, Jekyll и Javadoc в качестве генератора документации. Пожалуйста, попробуйте, и любая обратная связь будет принята с благодарностью.

Ответ 3

См. ответ на этот question (полное раскрытие, я задал вопрос, не получил ответа, сделал некоторые исследования и кодирование и отправил ответ, так что пока там там могут быть лучшие. Я был бы очень обязан, если бы кто-то указал их.)

Это gitlab repo показывает рабочий пример здесь.

Использует статическую защиту паролем и также обсуждается в этом issue.