2016-01-20 2 views
0

Мне интересно, есть ли способ настроить файл makefile для справки sphinx?Как настроить make-файл документации sphinx?

Что я хочу достичь, так это то, что каждый раз, когда я делаю make html, sphinx отправляется в определенный каталог и копирует конкретный файл в мой каталог source.


Например:

Предположим, у меня есть скрипт имя foo.py под ~/bar каталога. Я хочу, чтобы foo.py был скопирован в каталог ~/docs/source/, на который будут ссылаться мои project.rst.


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

Я знаю, что могу достичь этой цели с помощью простого сценария оболочки. Но, мне интересно, могу ли я сделать это прямо через файл sphinx make?

Спасибо большое!

ответ

1

Простое решение - создать символическую/жесткую ссылку (ln -s path/to/destination path/to/link, удалите -s для жесткой ссылки).

В вашем случае ln -s ~/bar/foo.py ~/docs/source/foo.py создаст ссылку в каталоге ~/docs/source/ (всегда актуальный, потому что это всего лишь ссылка на ваш исходный файл).

Для получения более подробной информации о правилах Makefile, посмотрите this customized sphinx Makefile. Существует множество правил, которые отправляют файлы через Интернет или из одного каталога в другой (в моем случае ~/web-sphinx/.build/html/* - ~/Public/).

Смежные вопросы