:orphan: |rss_image| **2018-04 - 1/1** :ref:`Blog ` :ref:`notebook (8) ` :ref:`sphinx (13) ` .. |rss_image| image:: feed-icon-16x16.png :target: ../_downloads/rss.xml :alt: RSS ---- .. index:: 2018-04 .. _ap-month-2018-04-0: 2018-04 - 1/1 +++++++++++++ .. blogpostagg:: :title: Check RST syntax :date: 2018-04-21 :keywords: sphinx,RST :categories: sphinx :rawfile: 2018/2018-04-21_compile_rst.rst It is usually a pain to discover I made an error in a formula while I'm writing documentation. It fails quite long after after the unit tests started. The documentation is generated after the unit test pass. I also use a lot ``.. runpython::`` (see :class:`RunPythonDirective `) to run pieces of code inside the documentation. It is quite annoying to discover it fails long after. So I creates a unit test which can be used to compile a single page of the documentation : `test_doc_page `_. I modify the page name when I have some doubt or I move to another one. ---- |rss_image| **2018-04 - 1/1** :ref:`2020-08 (2) ` :ref:`2020-09 (1) ` :ref:`2021-01 (1) ` :ref:`2022-03 (1) ` :ref:`2023-05 (1) `