Я собираю пакет в PyCharm и хочу документировать, используя Sphinx и Jupyter Notebooks.Более конкретно, я хотел бы добавить страницу «учебника» в документацию, где я показываю пример импорта моего пакета, делаю с ним что-то и включаю вывод, который получит пользователь.
Установка, которая у меня сейчас есть, кажется довольно сложной, сложной для управления и громоздкой.Мне было интересно, попробовал ли кто-то подобную настройку и нашел лучший способ сделать это.
В настоящее время у меня есть программа в PyCharm, где у меня есть среда для разработки и тестирования моего пакета.
Затем я устанавливаю пакет в моей корневой среде Anaconda, используя python setup.py develop.Теперь я могу запустить любой созданный мной Блокнот Jupyter из любого места, используя ядро IPython по умолчанию, и импортировать мой пакет.
Наконец, я запускаю Sphinx в корневой среде Anaconda, чтобы при сборке HTML он мог без проблем включать и запускать Блокнот.
Это работает, но кажется непонятным делать все это из корня Анаконды.В идеале мне бы хотелось иметь отдельную среду для создания документов, где я могу редактировать и запускать Блокнот, а также создавать документацию.
Есть предложения?