Я работаю над проектом колбы, который хорошо документирован и прокомментирован.
Я использовал sphinx для создания документации и хочу создать ссылку на мой код на index.html
, чтобы люди могли получить доступ к документации.
Как я могу добавить ссылку на мой index.html
из папки с шаблонами фляги?
Я не могу предоставить рабочий пример, потому что сам ищу его.
Моя структура проекта:
/main_folder
----/docs
--------/_build
--------/_static
--------/_templates
--------/rst
------------/app.rst
------------/otherfiles.rst
--------/app.rst
--------/index.rst
--------/config.py
----/myproject
--------/module1
--------/static
--------/templates
------------/project-index.html
----/app.py
РЕДАКТИРОВАТЬ 1: Я успешно создал HTML, используя:
sphinx-build
make html
(It does prompt warnings but no important)
У меня есть всеHTML, созданный, я не знаю, как подключить ссылку в форме project-index.html
к index.html
, потому что проект не имеет доступа к /docs
Да, я прочитал документацию о том, как mnake произвольных гиперссылок
РЕДАКТИРОВАТЬ 2:
Конфигурация для приложения включает в себя папку /myproject/static
в качестве статической папки для поиска CSS, JS и изображений.