Добро пожаловать в сборник конспектов!

Даннй проект будет использоован мной для начала в качестве тренажера по составлению документации в Read the Docs. А далее как сборник конспектов для замещения физических тетрадей.

Для чего создан этот сайт:

  1. Моя тренировка составления документации Read the Docs, работы со sphinx, Git, LaTeX и Jupyter Notebook, чтобы в будущем написать хорошую онлайн-документацию для Python-библиотеки.

  2. Централизация всех конспектов по кодингу в одном месте, а также их оцифровка.

Актуальные проблемы для разрешения:

1. Исправить некорректные изображения в Jupyter notebook’ах: повторяются одно и то же изображение, по всей видимости потому что при копировании изображений в JN у них одно название. В raw-виде они отображаются как различные. .. caution:

Потенциально эта проблема решается конвертацией JN в формат rst с помощью nbconverts. Но для ускорения работы лучше, чтобы с самого начала корректное отображение работала в JN-документах.

  1. Не отображаются подпункты в JN низкого уровня.

3. Файлы JN автоматически разделяются по главам первого уровня на отдельные страницы, также отображаются как отдельные пунткы в toctree. .. caution:

потенциально эта проблема решается оставлением только одного пункта первого уровня в JN-документе.

  1. Я не знаю как писать Latex-синтаксис в rst-файлах.

  2. Некоторые темы разбросаны в нескольких файлах. Их надо объединить под одними темами или объединить сами файлы. Для этого вероятно нужно сделать несколько уровней в toctree.

  3. Неплохо было бы иметь название тем в toctree, не зависящих от заголовка в JN или rst файлов.

Caution

Это лучше в параллельный проект учебника, для которого использовать Санин template Первое, что я напишу - это то, как собственно работать со Sphinx и Read The Docs TOC - table of contents tree

Danger

Это лучше в параллельный проект учебника, для которого использовать Санин template Первое, что я напишу - это то, как собственно работать со Sphinx и Read The Docs TOC - table of contents tree

Tip

Это лучше в параллельный проект учебника, для которого использовать Санин template Первое, что я напишу - это то, как собственно работать со Sphinx и Read The Docs TOC - table of contents tree

Note

Это лучше в параллельный проект учебника, для которого использовать Санин template Первое, что я напишу - это то, как собственно работать со Sphinx и Read The Docs TOC - table of contents tree

Пример кода Python:

def blabla(x):
   return x**2

  1. notebooks/(TEXTBOOK) Matplotlib

  2. notebooks/(TEXTBOOK) Econometrics

  3. notebooks/(TEXTBOOK) linearmodels

  4. notebooks/(TEXTBOOK) Optimization

  5. notebooks/(TEXTBOOK) pandas

Темы:

Indices and tables